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

Automate GitHub Pages generation #477

Closed
1 task
dan-zheng opened this issue Jan 20, 2021 · 6 comments
Closed
1 task

Automate GitHub Pages generation #477

dan-zheng opened this issue Jan 20, 2021 · 6 comments
Labels
maintenance Maintenance tasks (build systems, CI, code cleanup, etc)

Comments

@dan-zheng
Copy link
Collaborator

Task

We can use GitHub Actions to automate GitHub Pages updates: running make docs and pushing the output to gh-pages branch. So far, we've been updating gh-pages branch manually.

Automation suggested here: #472 (comment)

Considerations

  • gh-pages branch currently has some hardcoded stop-gap HTML redirection pages, added in Add HTML redirection pages. #392. We should consider what to do with those - maybe we're okay with dropping those pages by now.
@dan-zheng dan-zheng added the maintenance Maintenance tasks (build systems, CI, code cleanup, etc) label Jan 20, 2021
@oxinabox
Copy link
Contributor

possible duplicate of #291

@srush
Copy link
Contributor

srush commented Jan 20, 2021

You could just check those pages into docs/

@apaszke
Copy link
Collaborator

apaszke commented Jan 21, 2021

I'll close this since it's a duplicate. About checking in to docs/, I don't see how this simplifies things. Checking in to main is equally hard as checking in to gh-pages, with the latter also having the benefit of being accessible via a URL that skips the GitHub UI.

@apaszke apaszke closed this as completed Jan 21, 2021
@srush
Copy link
Contributor

srush commented Jan 21, 2021

Oh I just meant if there were a fixed set of extra static landing pages you could check them in somewhere.

The main suggestion was to use GitHub actions to generate the gh-pages. GitHub actions could also generate these static pages as well.

@apaszke
Copy link
Collaborator

apaszke commented Jan 21, 2021

I'm not sure if I follow. gh-pages is already the branch that contains the check in of those static pages.

@srush
Copy link
Contributor

srush commented Jan 21, 2021

If we move to a world where gh-pages is an automatically built branch, then one setup would be to just deploy clean to it every time master is updated by rebuilding the html pages in GitHub actions.

@dan-zheng was worried that this would make it difficult to also have manually created html pages there.

One solution would be to move those manual pages somewhere else, another would be to only update the non manual part of the branch, a final solution would be to have no manual pages and just autogen placeholders.

This is not an interesting problem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Maintenance tasks (build systems, CI, code cleanup, etc)
Projects
None yet
Development

No branches or pull requests

4 participants