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

enabling versioning of documentation: #45

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ppanero
Copy link
Member

@ppanero ppanero commented Mar 30, 2020

Closes #44

Instructions have been moved to the README file.

Open Questions:

  • Do we want to push to GH pages? Shall we use another domain? How does this work with GH pages? This should be decided before merging this since it can change the way of deploying/working with it.
  • Indentation of the yaml files. This comes from the usage of from ruamel.yaml.util import load_yaml_guess_indent in the install_extras command. Somehow it is interpreting 4 spaces instead of 2.
  • The version appears on the install tab instead of the home one. This can be modified in the docs/js/version-select.js and it is easy to do. However, we can just put it somewhere different, top corners? bottom corners? WDYT?

Screenshot 2020-04-01 at 10 58 20

Example:

https://ppanero.github.io/docs-invenio-rdm/0.7.0/
https://ppanero.github.io/docs-invenio-rdm/0.7.1/
https://ppanero.github.io/docs-invenio-rdm/latest/ --> points to https://ppanero.github.io/docs-invenio-rdm/0.7.1/
https://ppanero.github.io/docs-invenio-rdm/ --> redirect to https://ppanero.github.io/docs-invenio-rdm/latest

@fenekku
Copy link
Collaborator

fenekku commented Mar 30, 2020

We are not using https://github.com/zayd62/mkdocs-versioning/ in the end? Your fix has been merged in. Seems like mike doesn't quite support editing previous documentation which I feel we will need.

Copy link
Collaborator

@fenekku fenekku left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question above about using this over the other plugin...

@@ -1,76 +1,79 @@
# Project information
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: Does mike auto-rewrite the mkdocs.yml? I am not sure I like this 😅

- type: comments
link: https://invenio-talk.web.cern.ch/c/projects/invenio-rdm
- type: globe
link: https://inveniosoftware.org/products/rdm/
extra_css:
- stylesheets/extra.css

# Extensions
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: misalignment of the comment I think

permalink: true
permalink: true
extra_javascript:
- js/version-select.js
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moderate: Are indentation: 4 spaces or 2 spaces?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

support different versions
2 participants