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

Maintain 'Contributing to Rockstor' doc as canonical #350

Closed
phillxnet opened this issue Aug 28, 2023 · 2 comments · Fixed by #352
Closed

Maintain 'Contributing to Rockstor' doc as canonical #350

phillxnet opened this issue Aug 28, 2023 · 2 comments · Fixed by #352

Comments

@phillxnet
Copy link
Member

Thanks to @StephenBrown2 for helping to highlight this issue. It is proposed that we move the following contributor related section of our rockon-registry README.md to our canonical contributor doc reference for the same: https://rockstor.com/docs/contribute/contribute_rockons.html

@Hooverdan96
Copy link
Member

Hooverdan96 commented Sep 21, 2023

Looking at this a bit more closely, this could be a refactoring approach:

In the Readme, keep this:
image
link back to the Rockstor docs and move (and merge or replace in the docs) these sections:

  • Keep the header, ref to docs and move everything under How can I add ...
  • Adding vs. Updating ...
  • One Time setup ...
  • Steps to Contribute...

Keep the What is the Structure where it is on the repo, but add a link in the documentation for it. I feel, since that's a fairly technical detail, and also describes a "living" structure under development (hopefully more soon :) ) it belongs there, but should definitely be referenced from the main Rockstor docs.

Furthermore, refactor this section in the Rockstor docs:
https://rockstor.com/docs/interface/overview.html#adding-rockons (since it references github sections a few times)

A possible plan would be to update the rockstor documentation first (with all above mentioned details), and then cleanse the Readme on github.

@phillxnet
Copy link
Member Author

@Hooverdan96 This all sounds ideal to me. Thanks for progressing this issue more into the concrete realm.

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 a pull request may close this issue.

2 participants