rockstor / rockstor-doc

Rockstor documentation
http://rockstor.com/docs
Other
25 stars 30 forks source link

Add documentation about Rock-on restore #406

Closed Stitch10925 closed 1 year ago

Stitch10925 commented 1 year ago

Fixes: https://forum.rockstor.com/t/after-reinstall-rockons-are-running-but-not-showing-in-webui-as-installed/8640

Checklist

phillxnet commented 1 year ago

Just copying in a pic of the render of the new warning section on the Rock-ons-root: new-systemd-drive-rock-ons-root-warning

to assist further review is required.

Stitch10925 commented 1 year ago

@phillxnet

Thanks for adding an explanation to the suggestion. This provides some needed context in some cases. I accepted your changes.

Stitch10925 commented 1 year ago

Currently it looks to render as I think you intended

I would hope so. I ran it through Sphinx and hosted the pages using Python as described in the documentation (which was really great and easy to set up).

phillxnet commented 1 year ago

@Stitch10925 I think we are almost there now. Our back-end deployment (to PRODUCTION) treats Sphinx warnings as errors (@FroggyFlox maybe we should do the same on our GitHub Task):

Note the following, in the now enabled for your doc pull requests:

https://github.com/rockstor/rockstor-doc/actions/runs/4028122554/jobs/6931419590#step:5:84

We have a remaining underline warning issue on a couple of the headers.

Do you fancy popping in a commit to resolve this. Much appreciated. The GitHub Web-UI makes this sort of change a little challenging. But once committed the GitHub task should re-run and you can check if the warnings have been resolved. My fault as I should have enabled the GitHub task earlier. Our Back-end deployment double check however so at least we caught this there.

We didn't use to fail on warnings but they end up building up and then it's difficult to see what's going on, where as treating them as errors means we get a deployment failure to help flag mistakes such as mine here.

phillxnet commented 1 year ago

Copying in back-end Sphinx command used:

sphinx-build -b html -E -W . _build/html
Stitch10925 commented 1 year ago

Sorry for the delay guys!

I fixed the warnings. Too bad the action does not run on its own but needs approval. I hope everything is fine this time.

phillxnet commented 1 year ago

@Stitch10925 Thanks for persisting with this one. Sometimes it takes a little back and forth.

And thanks again for seeing to this previously missing area in our docs. Much appreciated.

I'll merger directly and publish shortly.

@FroggyFlox Thanks for the follow-up review. Again much appreciated.

phillxnet commented 1 year ago

PR product PRODUCTION published.