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

Publish docs with docsify #4193

Merged
merged 2 commits into from Feb 7, 2019

Conversation

Projects
None yet
4 participants
@Miouge1
Copy link
Member

Miouge1 commented Feb 6, 2019

Using docsify to make a docs website

Mirror available here: https://miouge1.github.io/kubespray-docs/

@k8s-ci-robot k8s-ci-robot requested review from mattymo and mirwan Feb 6, 2019

@k8s-ci-robot k8s-ci-robot added the size/M label Feb 6, 2019

@Miouge1 Miouge1 force-pushed the Miouge1:docsify branch 6 times, most recently from 39e6205 to b2d119a Feb 6, 2019

@Miouge1

This comment has been minimized.

Copy link
Member Author

Miouge1 commented Feb 6, 2019

This is using GitLab pages, but it's also possible (simpler?) to use GitHub Pages, we would move files into docs/ then enable GitHub Pages on master branch docs/ folder. (see deploy doc)

@Miouge1

This comment has been minimized.

Copy link
Member Author

Miouge1 commented Feb 6, 2019

@Atoms is that what you had in mind?

@Miouge1

This comment has been minimized.

Copy link
Member Author

Miouge1 commented Feb 6, 2019

ci check this

@Atoms

This comment has been minimized.

Copy link
Member

Atoms commented Feb 7, 2019

this seems awesome, just some 404 pops up

Show resolved Hide resolved docsify/sidebar.md Outdated
@Atoms

This comment has been minimized.

Copy link
Member

Atoms commented Feb 7, 2019

also i would say github pages would be simpler, can we try there?

@Miouge1 Miouge1 force-pushed the Miouge1:docsify branch 2 times, most recently from a8f09eb to ccdc42f Feb 7, 2019

@Miouge1 Miouge1 changed the title [WIP] Publish docs with docsify Publish docs with docsify Feb 7, 2019

@Miouge1

This comment has been minimized.

Copy link
Member Author

Miouge1 commented Feb 7, 2019

OK. I refactored this to be GitHub Pages rather than GitLab Pages.

Since GitHub pages works only on master, I made another fork to test this out:

And here is a screenshot of the GitHub Pages config, someone with owner access has to enable it on the kubernetes-sigs/kubespray repo. I would suggest to test things with https://kubernetes-sigs.github.io/kubespray/ then enable the kubespray.io custom domain once it's confirmed working (it's just a CNAME config https://help.github.com/articles/quick-start-setting-up-a-custom-domain/)

screen shot 2019-02-07 at 09 06 50

@Miouge1 Miouge1 force-pushed the Miouge1:docsify branch from ccdc42f to 78a7b5f Feb 7, 2019

@Atoms

This comment has been minimized.

Copy link
Member

Atoms commented Feb 7, 2019

@mattymo please enable github pages

@mattymo

This comment has been minimized.

Copy link
Contributor

mattymo commented Feb 7, 2019

@Atoms github pages is enabled

@mattymo

This comment has been minimized.

Copy link
Contributor

mattymo commented Feb 7, 2019

/lgtm

@Atoms

This comment has been minimized.

Copy link
Member

Atoms commented Feb 7, 2019

/approve

@k8s-ci-robot

This comment has been minimized.

Copy link
Contributor

k8s-ci-robot commented Feb 7, 2019

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Atoms, Miouge1

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 9e76aaf into kubernetes-sigs:master Feb 7, 2019

3 checks passed

cla/linuxfoundation Miouge1 authorized
Details
kubespray-ci/pipeline Pipeline Succeeded
Details
tide In merge pool.
Details

qvicksilver added a commit to qvicksilver/kubespray that referenced this pull request Feb 7, 2019

Publish docs with docsify (kubernetes-sigs#4193)
* Add docsify website

* Add website CI

@Miouge1 Miouge1 referenced this pull request Feb 8, 2019

Merged

Add more links to the docs #4204

LuckySB added a commit to centosadmin/kubespray that referenced this pull request Feb 18, 2019

Publish docs with docsify (kubernetes-sigs#4193)
* Add docsify website

* Add website CI
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.