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 Rails (from FileScraper to UrlScraper) #1580

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

MasterEnoc
Copy link
Contributor

  • 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

The documentation scraped by the Rails FileScraper did not have source code links but the online documentaciones does. That is the main reason to move Rails from FileScraper to UrlScraper. The source code links would be helpful, as mentioned in #763.

@MasterEnoc MasterEnoc requested a review from a team as a code owner June 23, 2021 04:35
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.

1 participant