The Wayback Machine - http://web.archive.org/web/20201223144350/https://github.com/freeCodeCamp/devdocs/pull/1216
Skip to content

/ devdocs

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

Jump to bottom

update php documentation (7.4.5) #1216

Closed
wants to merge 1 commit into from
Closed

update php documentation (7.4.5) #1216

wants to merge 1 commit into from

Conversation

@jhdxr
Copy link

@jhdxr jhdxr commented Apr 21, 2020

If you're updating an existing documentation to it's latest version, please ensure that you have:

  • Updated the versions and releases in the scraper file
  • Ensured the license is up-to-date and that the documentation's entry in the array in about_tmpl.coffee matches it's data in self.attribution
  • Ensured the icons and the SOURCE file in public/icons/your_scraper_name/ are up-to-date if the documentation has a custom icon
  • Ensured self.links contains up-to-date urls if self.links is defined
  • Tested the changes locally to ensure:
    • The scraper still works without errors
    • The scraped documentation still looks consistent with the rest of DevDocs
    • The categorization of entries is still good
@jhdxr
update php documentation (7.4.3)
Loading status checks…
4dc2f52
@rickmacgillis
Copy link
Contributor

@rickmacgillis rickmacgillis commented May 18, 2020 •
edited

I was just about to write an update for the PHP versions, but it seems that @jhdxr beat me to it, so that saves me some work.

Any chance someone can inspect his PR and merge it for us?

EDIT:
I just noticed that he removed the old version of the docs instead of adding a versions list. I'm going to have a go at it to make it so people can select which version(s) they want to install.

EDIT 2:
So, when I went to the PHP website, I couldn't find a way to change the documentation version, so presumably that functionality doesn't exist, thus the dilemma for the PHP docs scrapper. Strange how after 17 years of working with PHP, I never noticed that it doesn't have multiple documentation versions on there. Oh well.

If jhdxr's code is up to spec for this project, then I recommend accepting the PR, as I know that the docs always states when certain features were made available or when they got remove, so the latest docs will be the most complete.
@jhdxr
Copy link
Author

@jhdxr jhdxr commented May 19, 2020

Hi @rickmacgillis

I just noticed that he removed the old version of the docs instead of adding a versions list. I'm going to have a go at it to make it so people can select which version(s) they want to install.
The reason I do so is it's how devdocs deal with php document now, and so does php.net.

Since php document is basicly a reference for all the php functions. It indicates since when functions are avaliable or removed rather than providing documentation for different php versions.
@zicjin
Copy link

@zicjin zicjin commented Jun 23, 2020

@jhdxr May I ask this PR support from https://www.php.net/distributions /manual/php_manual_en.tar.gz Download the offline documentation? I download the offline document and execute "thor docs:generate php", why do I get a lot of code that doesn't match the actual html structure? clear_html.rb:16 at_css('.manualnavbar') Object Non-existent.
@simon04
simon04 requested changes Nov 13, 2020
View changes
Copy link
Contributor

@simon04 simon04 left a comment

I cannot build the docs after downloading the 2020-11-13 version from php.net via mkdir -p docs/php/; curl https://www.php.net/distributions/manual/php_manual_en.tar.gz | tar xz --strip-components=1 --directory=docs/php/
@jhdxr
Copy link
Author

@jhdxr jhdxr commented Dec 16, 2020

Sorry I'm going to abandon this PR. It seems the php manual updated its css and dom, so besides the contents changes (including new pages, excluding removed pages, like what this PR does), the more important thing is to update the filters to make it compatibile with the latest manual. I don't have enough time to check and implement those changes currently. Maybe @rickmacgillis can help on this? If you are still interested in it.
@jhdxr jhdxr closed this Dec 16, 2020
@simon04
Copy link
Contributor

@simon04 simon04 commented Dec 16, 2020

If you are still interested in it.

If the question was directed to the @freeCodeCamp/devdocs team: yes, definitively!
@jhdxr
Copy link
Author

@jhdxr jhdxr commented Dec 18, 2020

@simon04 Really glad to hear that. Hope to see it get updated soon. Thanks.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simon04 simon04

Assignees
No one assigned
Labels
docs/update issue/needs-info
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
@jhdxr @rickmacgillis @zicjin @simon04
You can’t perform that action at this time.