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

Fix versioning of library #47

Open
nkoenig opened this issue Jul 27, 2020 · 0 comments
Open

Fix versioning of library #47

nkoenig opened this issue Jul 27, 2020 · 0 comments
Assignees
Labels
infrastructure Requires changes on the web server or other infra

Comments

@nkoenig
Copy link
Contributor

nkoenig commented Jul 27, 2020

Library versions too granular

Library docs shouldn’t be re-released for minor patch releases, like 1.0.0 and 1.0.1. There should only be versioning for major releases.

No versioning for Ignition releases

Currently, the library docs are versioned for new releases of the library itself, but do not indicate which version of Ignition each version belongs to.

The “general” docs (/docs) are also not versioned, resulting in multiples of the same pages (installation, ros integration, comparison, etc.) residing in the same repository.

The complete documentation should be versioned under Ignition release names. The address taxonomy could look something like this:

Where only the “/<version_num>”s corresponding to a certain release would be available to view when that release is selected.

Whether implementing this is practically possible (presumably using scripts to pull docs from different repos, and different branches within those repos, depending on the branch built in the original repo) would need to be determined.

@nkoenig nkoenig self-assigned this Jul 27, 2020
@chapulina chapulina added boost the docs infrastructure Requires changes on the web server or other infra labels Jul 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Requires changes on the web server or other infra
Projects
None yet
Development

No branches or pull requests

2 participants