Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove help module from core #75

Closed
jenlampton opened this issue Sep 14, 2013 · 13 comments · Fixed by backdrop/backdrop#79
Closed

Remove help module from core #75

jenlampton opened this issue Sep 14, 2013 · 13 comments · Fixed by backdrop/backdrop#79

Comments

@jenlampton
Copy link
Member

No description provided.

@molenick
Copy link

Would this include removing all implementations of hook_help in core?

@molenick
Copy link

I took an initial stab at this, removing the module and all implementations of hook_help. Take a look and let's see if it's adequate to do a pull request for.

https://github.com/flaneur-de-mal/backdrop/commit/64ca293bac7cbcfa641b6751b5cc8df9b8ccf653

@quicksketch
Copy link
Member

Would this include removing all implementations of hook_help in core?

Yep!

Take a look and let's see if it's adequate to do a pull request for.

Looking good! Travis CI currently reports success even though there are failures in the detailed results: https://travis-ci.org/backdrop/backdrop/builds/11618873

A lot of tests do weird things like check for the help-text on a page to make sure it loaded correctly. We'll need to replace the test values with other content on the page if possible. Great start though, thanks!!

@molenick
Copy link

Great, thanks for the feedback. I'll try to find time to look at removing help module code from the tests, but I'm not too familiar with it. If anyone can provide a pattern to look for (code and what files to look in) I'd be glad do what's required to finish help's removal.

@molenick
Copy link

Also, if anyone wants to do that part themselves, I'd be glad to welcome the contribution. I'm not really familiar with the github way of contribution, but I imagine you could fork my fork, submit a pull request, and then I could accept it into my pull request back into backdrop. Is this the best way?

@hosef
Copy link

hosef commented Sep 22, 2013

I am going start working on fixing the tests. I am going to do it as you said(fork the fork) and just make a pull request to you, so we can keep record of who made which changes.

@quicksketch
Copy link
Member

We've got two pull requests for this (both from 5 days ago) but neither is merge-able currently:

@flaneur-de-mal: backdrop/backdrop#63
@robbiethegeek: backdrop/backdrop#62

It sounds like @hosef is working on this issue right now(?) The effort here is great, but let's try to mitigate duplicate work. :)

Multiple pull requests are totally cool, it's just like different people posting different patches. We just want to make sure people are building off the previous pull requests, either by setting up a remote based on someone else's fork and then file your own PR, or by collaborating in the same repository by granting each other access.

It doesn't seem like Github let's you truly "fork a fork" in the UI, instead if you fork someone else fork, any pull requests you make go back to the original repository (which is probably a good thing). Unfortunately if you already have a fork of that original repo, the button for forking a fork doesn't seem to do anything at all.

@sun
Copy link

sun commented Sep 25, 2013

# Add someone else's fork to your fork.
$ git remote add $username $fork_uri
# Fetch his/her work.
$ git fetch $username
# Check out the feature branch (or PR) to work/advance on.
$ git checkout -b $feature origin/$username/$feature
# Add commits...
# Push to your remote.
$ git push -u origin $feature
# Visit your fork on GitHub, where GitHub will offer you a PR against $username.

@oadaeh
Copy link

oadaeh commented Sep 25, 2013

Just as an FYI, AFAIK, @hosef has been running tests on his local environment and removing those that fail due to a lack of the Help module. I don't know if he started from one of the PRs mentioned or not (I assume so), but I know he was looking for a way to fork a fork, so @sun's instructions will be helpful.

@hosef
Copy link

hosef commented Sep 27, 2013

So, I am working on this and I actually figured out how to pull @flaneur-de-mal's changes into a branch on my repo through the Github interface. However, it has been going slow as my distro uses PHP 5.5.4 by default, so I get lots of errors that are completely irreverent to the issue at hand.

@behindthepage
Copy link

Is there something to replace the old help text or do we hard code useful info into pages?

Regards
Geoff

@quicksketch
Copy link
Member

Is there something to replace the old help text or do we hard code useful info into pages?

Yep, it's expected that you'll add help on the pages directly, such as $form['help']['#markup'] = $help. Although I think it'd be a good idea for us to make some kind of standard help wrapper so you don't have to be responsible for wrapping paragraphs tags and classes.

@behindthepage
Copy link

Ok thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants