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

Document rocknets creation and use. #257

Merged

Conversation

FroggyFlox
Copy link
Member

@FroggyFlox FroggyFlox commented Dec 28, 2020

Fixes #256
@phillxnet, ready for review.

This pull request's proposal

Following the merging of rockstor/rockstor-core#2207, we should add corresponding documentation on rocknets. This pull request (PR) thus adds the following to Rockstor's documentation:

  • description of the "docker" type when creating a new network connection.
  • description of the new "Networking" dialog window and its use to edit ports' publication state as well as creating/joining/leaving rocknets

@phillxnet, note that I created and placed all new screenshots related to the rock-ons documentation in a new folder inside the images directory in the root folder... It was in an effort to limit the multiplication of screenshots in the docker-based-rock-ons folder; I was thinking of progressively moving all images for the docker-based-rock-ons folder in future PRs. Let me know if you think that's an appropriate organization.

Checklist

  • With the proposed changes no Sphinx errors or warnings are generated.
  • I have added my name to the AUTHORS file, if required (descending alphabetical order).

@phillxnet
Copy link
Member

phillxnet commented Dec 28, 2020

@FroggyFlox Re:

Let me know if you think that's an appropriate organization.

That makes sense. Your call as you see fit really. As long the the result renders OK it would be good to do what ever tidy/organisation we can manage.
Thanks for looking after this, much appreciated, and thanks also for your efforts in not only adding this new feature but also tending to the docs.
I can hopefully take a look soon but if your're find with what you have submitted here then I am also.

@FroggyFlox
Copy link
Member Author

I can hopefully take a look soon but if your're find with what you have submitted here then I am also.

No worries... It would only be useful once the next rpm is released anyway so I don't see an emergency to rush this PR for now.

Thanks a lot for your time, and take care!

@FroggyFlox
Copy link
Member Author

@phillxnet , I've updated the images' :scale: parameter to use :width: 100% for those that could benefit from it, as discussed in #258. This was done only in the files changed in this PR, however:

  • overview.rst
  • network.rst

It still builds fine on my end so based on your previous comment, I might merge this in and publish it in a little bit given the feature is now released in Rockstor 4.0.5.

Cheers!

@FroggyFlox FroggyFlox merged commit 7d44d7a into rockstor:master Jan 4, 2021
@FroggyFlox FroggyFlox deleted the Issue256_AddRockonNetworkingDocs branch February 1, 2021 13:43
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.

Document Rocknets (docker networks)
2 participants