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 Phalcon version 3 and add Phalcon version 4 #1376

Draft
wants to merge 3 commits into
base: master
from
Draft

Update Phalcon version 3 and add Phalcon version 4 #1376

wants to merge 3 commits into from
+138 −52

Conversation

@MasterEnoc
Copy link
Contributor

@MasterEnoc MasterEnoc commented Nov 24, 2020

  • 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

Note that version 2 was removed because its documentation pages are no longer available.
@MasterEnoc
Update Phalcon version 3 and add Phalcon version 4
Loading status checks…
0170722 
- Delete Phalcon version 2 since pages of its documentations
  are not longer available
@MasterEnoc MasterEnoc requested a review from freeCodeCamp/devdocs as a code owner Nov 24, 2020
@simon04
Copy link
Contributor

@simon04 simon04 commented Nov 24, 2020

Note that version 2 was removed because its documentation pages are no longer available.

If feasible, we should archive the old versions in devdocs nevertheless…

Syntax highlighting is broken: 2020-11-24-231301
MasterEnoc added 2 commits Nov 25, 2020
@MasterEnoc
Add syntax highlight
Loading status checks…
279739e
@MasterEnoc
Remove 'hr' lines
Loading status checks…
e7773af
@MasterEnoc
Copy link
Contributor Author

@MasterEnoc MasterEnoc commented Nov 25, 2020

Syntax highlight added and style improved. Proceed to review
@simon04
Copy link
Contributor

@simon04 simon04 commented Nov 26, 2020

The methods of a class lost their styles…

2020-11-26-230256
@MasterEnoc
Copy link
Contributor Author

@MasterEnoc MasterEnoc commented Nov 27, 2020

This lack of style happened because of the html implemented in the page. Now phalcon docs use 'p' and 'table' tags for methods without any particular id or class, as you can see in the images I'm attaching. Style can be implemented but I have to figure out how since traversing through all the 'p' and 'table' tags would break the style.
image
image
@scherepn
Copy link
Contributor

@scherepn scherepn commented Dec 3, 2020

Wow. The new phalcon documentation is truly terrible. It's perhaps the worst documentation I've seen so far.

It may actually be easier to contact the Phalcon team and work with them to improve their documentation than fix it on our end.
@simon04 simon04 marked this pull request as draft Dec 14, 2020
@scherepn scherepn mentioned this pull request Dec 22, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@freeCodeCamp/devdocs devdocs

Assignees
No one assigned
Labels
docs/update
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
@MasterEnoc @simon04 @scherepn
You can’t perform that action at this time.