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

NMS-13870: Add Nephron documentation #15

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

Conversation

indigo423
Copy link
Member

@indigo423 indigo423 commented Dec 21, 2021

Depends on OpenNMS/nephron#43 and adds Nephron to be published on docs.opennms.com

JIRA: https://issues.opennms.org/browse/NMS-13870

Bonrob2
Bonrob2 previously approved these changes Jan 10, 2022
Copy link
Contributor

@Bonrob2 Bonrob2 left a comment

Choose a reason for hiding this comment

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

LGTM.

@Bonrob2
Copy link
Contributor

Bonrob2 commented Jan 13, 2022

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?

@indigo423
Copy link
Member Author

indigo423 commented Feb 2, 2022

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?

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.

@indigo423
Copy link
Member Author

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.

@Bonrob2
Copy link
Contributor

Bonrob2 commented Feb 2, 2022

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)

@indigo423
Copy link
Member Author

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.

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.

2 participants