gh-pages deployment with material theme #2966
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The cause of this 404: locally mkdocs serves this "configuration files"
page as localhost:8000/Advanced-configuration/, while on github.io we
have .github.io/MongooseIM/advanced-configuration/configuration-files/,
mind the last part of the link. The latter way of handling it is the
correct one.
If we want to keep this chapter as “configuration files”, in mkdocs.yml it should be:
- 'Configuration':
- 'Configuration files': 'advanced-configuration/Configuration-files.md'
andalso mv doc/Advanced-configuration.md doc/advanced-configuration/Configuration-files.md.
The last step is to update its link in Jingle-SIP-setup.md and everything is clean.
NelsonVides
force-pushed
the
docs_material_deploy
branch
5 times, most recently
from
f5d7c84
to
cd14885
Compare
NelsonVides
force-pushed
the
docs_material_deploy
branch
from
cd14885
to
cff38e0
Compare
leszke
approved these changes
Dec 4, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So this PR does several things. The point is to migrate to gh-pages, as it allows us to use any theme we want, which enables us to move forward with the idea of improving the look&feel of the mongooseim documentation.
This documentation is generated using
mike, which, using mkdocs and material, enables us to build several versions, tagging them and pushing them.How mkdocs generate these sites? Compiling all the markdown files and the mkdocs.yml into a huge bunch of static html and css files. mike injects some minor javascript then to allow to change versions. These lots of autogenerated files are then pushed to a github repo that github allows to serve as static pages. But the amount of autogenerated stuff is too big to keep in our main repo, so these things are pushed to a new repo we've made, https://github.com/esl/MongooseDocs.
More things that this PR does: migrating all links to readthedocs to our new pages, improving some http-to-https links (my firefox complained about that), improving some minor indentation and whitespace in doc files, and, importantly, adding building docs to the CircleCI pipeline. All branches will be built, but only tags and master will then be pushed.