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

Make the published book accessible on openra.net somewhere #3

Closed
phrohdoh opened this issue May 7, 2019 · 2 comments
Closed

Make the published book accessible on openra.net somewhere #3

phrohdoh opened this issue May 7, 2019 · 2 comments

Comments

@phrohdoh
Copy link
Member

phrohdoh commented May 7, 2019

Related Tickets

#1 - Publish book to GitHub Pages via Travis CI
#2 - Create a GitHub Personal Access Token and add it to Travis repository settings as GITHUB_TOKEN

Why

This will make the book accessible as part of openra.net instead of github.io which, in my opinion, signals that it is officially part of the OpenRA project.

Ticket Author's Personal Opinion

I believe https://docs.openra.net/book would be best because we can put other docs (such as how-tos, trait docs, who knows what we'll have in the future) under https://docs.openra.net/ for consistency.

https://docs.openra.net/ could be an index of sorts for OpenRA documentation which would allow for easy discoverability.

How

cc @Baxxster

As far as I know (once #1 and #2 are resolved) the book will be hosted at https://openra.github.io/book.

How this should be done technically I do not know 😢but I'd love to learn if someone is in a teaching me!

@ghost
Copy link

ghost commented May 8, 2019

See https://help.github.com/en/articles/using-a-custom-domain-with-github-pages and https://help.github.com/en/articles/user-organization-and-project-pages and https://help.github.com/en/articles/custom-domain-redirects-for-github-pages-sites.

I'm not sure how https://docs.openra.net/ and https://docs.openra.net/book would relate to each other. Usually, setting up the book's project page only creates the site under the subdirectory, but https://docs.openra.net/ would 404. You might be able to redirect the normal project page's URL to https://docs.openra.net/, but then all other projects that should live under their own subdirectory under the docs.openra.net domain would need to be contained in the book's repository I think. I think it would be easier to use a custom subdomain per project (book.openra.net / docs.openra.net) and manage everything in their own repositories.

@phrohdoh
Copy link
Member Author

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

No branches or pull requests

1 participant