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

Support base_url for internal links #89

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

arjunsuresh
Copy link
Contributor

This PR will enable any github fork to run the docs website from their fork by just adding q2a.github.io or the fork repo name as the base_url.

@arjunsuresh
Copy link
Contributor Author

URL of a working fork site: https://gateoverflow.github.io/q2a-docs/

@svivian
Copy link
Collaborator

svivian commented Nov 22, 2024

Thank you for the contribution, however, I don't understand the use case. The docs aren't intended to be hosted on other websites. To make changes you can use Jekyll and run it locally as described here. Let me know if I am missing something.

@arjunsuresh
Copy link
Contributor Author

Thank you for checking @svivian . Actually the use case is to make it easier for others to give PRs to the official documentation. For example, with this change, I can do edits on github, verify all the changes are as expected and then give a PR - all on a browser without worrying about any setups. Running jekyll locally is not very difficult - but it is still harder than just editing on a browser.

@svivian
Copy link
Collaborator

svivian commented Nov 22, 2024

How does that work? For example I have a fork of the docs repo here: https://github.com/svivian/q2a.github.io - is there a URL I can use to view my copy of the docs online?

@arjunsuresh
Copy link
Contributor Author

yes. But one problem is there - the fork name - the default "q2a.github.io" won't work as it is reserved by github.io. If you rename the fork to "q2a-docs", then the url will be https://svivian.github.io/q2a-docs (In the fork settings, github pages must be enabled)

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.

2 participants