Skip to content
This repository has been archived by the owner on Sep 20, 2024. It is now read-only.

Should we deploy the docs on GitHub pages or some other alternatives? #2180

Open
deepakmahakale opened this issue Dec 1, 2021 · 2 comments
Assignees

Comments

@deepakmahakale
Copy link
Contributor

deepakmahakale commented Dec 1, 2021

It will be easier to go through the docs if they are deployed somewhere with navigation like the previous site used to do.

I tried to move the docs to root and use GitHub pages but we may need to use some proper theme.

Can we move the /docs to root and try using GitHub pages?

Possible Solutions:

  1. Add the static site code to the gh-pages branch and deploy the branch using GitHub pages
  2. move the docs/ to root and deploy
  3. Any other alternatives?
@benbrown
Copy link
Contributor

benbrown commented Dec 1, 2021

@deepakmahakale that's an interesting idea. The nav is definitely helpful, I agree.

I would hate to change the URL of the docs as it is though since it will invalidate a bunch of URLs in search engines and links.

Does it have to be included in a gh-pages branch?

The process that builds the markdown files can be updated to write to multiple locations...

@stale
Copy link

stale bot commented Apr 16, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Apr 16, 2022
@benbrown benbrown removed the stale label Apr 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants