Skip to content

Update Pony documentation (0.38.1)#1410

Merged
simon04 merged 1 commit intofreeCodeCamp:masterfrom
scherepn:pony-update
Dec 7, 2020
Merged

Update Pony documentation (0.38.1)#1410
simon04 merged 1 commit intofreeCodeCamp:masterfrom
scherepn:pony-update

Conversation

@scherepn
Copy link
Copy Markdown
Contributor

@scherepn scherepn commented Dec 7, 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

Prism (the syntax highlighting library) doesn't currently support Pony, but tagging it now doesn't hurt and saves the effort to rebuild the docs if ever does in the future.

@scherepn scherepn requested a review from a team as a code owner December 7, 2020 10:19
Copy link
Copy Markdown
Contributor

@simon04 simon04 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@simon04 simon04 merged commit 23a0004 into freeCodeCamp:master Dec 7, 2020
@scherepn scherepn deleted the pony-update branch December 7, 2020 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants