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

Enable github pages for /docs #642

Closed
originalfoo opened this issue Feb 3, 2020 · 4 comments
Closed

Enable github pages for /docs #642

originalfoo opened this issue Feb 3, 2020 · 4 comments
Assignees
Labels
docs Documentation high priority Affects lots of users meta Build environment, github environment, etc.
Milestone

Comments

@originalfoo
Copy link
Member

originalfoo commented Feb 3, 2020

Aiming for 11.1, but would be sweet if we could get it done today for 11.0 release (depends on DNS propagation time but as nothing is yet caching tmpe.me it hopefully will be fresh from get go).

@krzychu124 : Enabling github pages - In GitHub: Settings tab > GitHub Pages

  1. Source: master branch /docs folder
  2. Theme: Cayman (it will do for now)
  3. Custom domain: tmpe.me

@kvakvs : Linking to custom domain:

The actual content of the docs site will just organically grow via PRs (possibly create docs branch for faster commits, then that can go through intermittent PRs to merge in to master?). Plan is to develop docs on github wiki, then every so often do a bulk update of /docs folder with content from the wiki. In theory the wiki (which is just a git repo) could be treated as a submodule. So lots of things to investigate at later date.

@originalfoo originalfoo added high priority Affects lots of users docs Documentation meta Build environment, github environment, etc. labels Feb 3, 2020
@originalfoo originalfoo added this to the 11.1 milestone Feb 3, 2020
@kvakvs
Copy link
Collaborator

kvakvs commented Feb 3, 2020

Poke me on Discord for setting up NS records and proving the domain ownership to Github.

@originalfoo
Copy link
Member Author

This initial stage is complete; @kvakvs if you need anything regarding SSL either reopen this or create new issue.

@kvakvs
Copy link
Collaborator

kvakvs commented Feb 4, 2020

I am waiting for @krzychu124 to click "Enforce SSL" and see what happens. It should become clickable in a few hours from the time of this comment.

@krzychu124
Copy link
Member

@kvakvs HTTPS enforced and it's working 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation high priority Affects lots of users meta Build environment, github environment, etc.
Projects
None yet
Development

No branches or pull requests

3 participants