-
Notifications
You must be signed in to change notification settings - Fork 6
NMS-13870: Add Nephron documentation #15
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
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Looking at this again, and wondering if we need separate docs for nephron. Is it going to be like Helm, or more like Sentinel/Minion? If the latter, we should just add nephron-related content to the main docs. Thoughts? |
61dbd6c
to
6b0533e
Compare
6b0533e
to
d4b1f65
Compare
cdfd12e
to
244a9fa
Compare
Core, Sentinel, and Minion are in the same GitHub repository and have the exact same release life cycle. They share the same version number. Nephron is a bit more like ALEC or Helm, it has its own software life cycle and release process. You want to update and publish Nephron docs independently with Nephron releases and you don't want to entangle your Nephron docs changes with Horizon/Meridian releases. |
If we merge the PR as it is now, we get the first docs published with the next 0.3.2 release from Nephron. The current release 0.3.1 doesn't have docs. |
I have docs ready to go as a first draft. (OpenNMS/nephron#47) |
FYI: The site.zip artifact from the build doesn't show the Nephron docs, the filter is set to Nephron version 0.3.2+ which isn't released with the Antora docs yet. They will show up when we have a Nephron 0.3.2 released. |
Depends on OpenNMS/nephron#43 and adds Nephron to be published on docs.opennms.com
JIRA: https://issues.opennms.org/browse/NMS-13870