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

Use relative URLs where possible #1191

Open
honzajavorek opened this issue Sep 9, 2024 · 0 comments
Open

Use relative URLs where possible #1191

honzajavorek opened this issue Sep 9, 2024 · 0 comments
Assignees
Labels
t-academy Issues related to Web Scraping and Apify academies. t-docs Issues owned by technical writing team.

Comments

@honzajavorek
Copy link
Collaborator

honzajavorek commented Sep 9, 2024

When reading the https://github.com/apify/apify-docs/pull/1117/files diff I noticed, once again, an absolute link to another page within the docs. I've seen this elsewhere throughout the docs. I think it's a remnant of some past re-orgs of the files, where files which were not part of a single repository now are. It would be nice if these links were identified and changed to local URLs:

  • Practically, this is an issue only during development, with links heading to the production website. The change of domain name in the address bar may not be easily noticeable and can cause issues like "I'm refreshing this page for 10th time and the content ain't changing according to my edits?!"
  • Theoretically, in case we have some Docusaurus plugins or tooling in the future, it would be vital that it has a correct graph of what is interconnected.

This is very low priority, but in my Academy stints there are sometimes periods of time when I wait for reviews, so I file this issue as a little task idea. Should be an easy search & replace.

@honzajavorek honzajavorek added t-academy Issues related to Web Scraping and Apify academies. t-docs Issues owned by technical writing team. labels Sep 9, 2024
@honzajavorek honzajavorek self-assigned this Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t-academy Issues related to Web Scraping and Apify academies. t-docs Issues owned by technical writing team.
Projects
None yet
Development

No branches or pull requests

1 participant