rockstor / rockstor-doc

Rockstor documentation
http://rockstor.com/docs
Other
24 stars 29 forks source link

Refactor Rock-on contribution from repository to Rockstor Documentation #452

Closed Hooverdan96 closed 11 months ago

Hooverdan96 commented 11 months ago

Fixes #451.

This pull request's proposal

Changes to be committed: modified: contribute/contribute_rockons.rst modified: interface/overview.rst

Checklist

Hooverdan96 commented 11 months ago

There are now 3 403 errors left during linkcheck all links related to this: https://linux.die.net/man/5/ - these seem to be new, the website links work if I visit them manually. Suspect it might be a block due to "source" being github for hitting that link, or it's somewhat related to one of the issues I found while researching where the Sphinx/linkcheck is having some issues for re-authorizing, due to the underlying python version and whatnot ...

I did see this one, might be a user-agent issue, too: https://github.com/sphinx-doc/sphinx/issues/10343

but I don't think it's something to be fixed on the github actions setup, unless it becomes more frequent with different websites ...

phillxnet commented 11 months ago

@Hooverdan96 Thanks for seeing to this modification/normalisation re our contribution docs. Much appreciated. Re:

There are now 3 403 errors

Same here when run locally: I think we just find alternatives to these as all three have pop-up adverts in anyway. So likely we can find a more canonical source for these 2 nfs and 1 sssd-ad man pages.

FroggyFlox commented 11 months ago

Thanks a lot indeed, @Hooverdan96 !

With regards to finding a better link to manpages, may I suggest https://manpages.opensuse.org/? Better suited to us and ad-free.

Hooverdan96 commented 11 months ago

I guess I didn't check the text enough after copying it ... thanks for the additional eyes on it, and the rewording suggestions made sense as well. I will create a separate issue/pull request to change the man-page targets, especially since those are in different parts of the documentation. @FroggyFlox thanks for the suggestion, the opensuse source makes even more sense to us now 💯

Hooverdan96 commented 11 months ago

Once you're satisfied with the changes, I can squash them into one commit (though I know you mentioned that it's probably less relevant for the documentation).

phillxnet commented 11 months ago

@Hooverdan96 Thanks again. About to merge. Re squashing I think it's less important to squash in docs/rock-ons/website as eases review / additional attribution / contributor burden: and clean history is less important than in code repositories. Plus we have only one branch in these repositories. So cherry picking requirement from one branch to another is not a thing.

phillxnet commented 11 months ago

PR product PRODUCTION published.