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

Update Elixir documentation (1.16 and 1.17) #2266

Merged
merged 2 commits into from
Jul 17, 2024

Conversation

breunigs
Copy link
Contributor

The guides have moved from a separate page into the same documentation system. This required shuffling of the cleanup functions, which is subtly incompatible with the docs of the older versions, or would have required if/else in various places. For legibility, I thus opted to remove old versions.

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

  • Updated the versions and releases in the scraper file
  • Ensured the license is up-to-date
  • 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

The guides have moved from a separate page into the same
documentation system. This required shuffling of the cleanup
functions, which is subtly incompatible with the docs of the
older versions, or would have required if/else in various places.
For legibility, I thus opted to remove old versions.
@breunigs breunigs marked this pull request as ready for review June 14, 2024 15:41
@breunigs breunigs requested a review from a team as a code owner June 14, 2024 15:41
Copy link
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 15b8875 into freeCodeCamp:main Jul 17, 2024
2 checks passed
@breunigs breunigs deleted the ex-1.16-1.17 branch July 17, 2024 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants