Immich writeup

[kanecko]

To ease and accelerate the PR submission, please use the template below to provide all required information.
Please see our "Contributing to Rockstor documentation" in our Rockstor's documentation

Fixes #569

This pull request's proposal

Immich write-up: installation + configuration of External Libraries.
I propose that after this write-up will be up-to-snuff and published, that I also link to it from Immich's docs: immich-app/static-pages#275

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]

@kanecko This is looking very promising. But you should be building locally ideally before submission. I've just run our Sphinx GitHub Action and if you take a look there are a number of warnings that we count as errors. We can't review this until they are cleared.

Looks like some label issues and some subtitle underline warnings. Once these are sorted with a follow-up commit we can do test renders and review the content.

Thanks for seeing to this doc, your Immich Rock-on is a great candidate for a doc counterpart as I expect it will be quite popular.

For how to test locally take a look at our following doc entry:

• https://rockstor.com/docs/contribute/contribute_documentation.html

There is also a docker image we publish, referenced in that doc, that makes testing easier as it contains a pre-build Sphinx ready to use for building our docs.

[kanecko]

Thanks for the direction!
This version is without errors and warnings.

[phillxnet]

@kanecko I've left a few minor suggestions/corrections. If you could take a look that would be great. But all-in this is a nice write-up. Thanks. Plus, well done on the comprehensive upstream links provided. I would say that maybe we could leave out some of the details re following wizards etc, where they are self explanatory, but that is likely best left for a follow-up pull request as things change. I think it's also OK to crop some images some-times as we have a lot of white-space in many of our dialogs. But gain - that would be for any follow-up pull requests.

Plus it would be great to get this published.

See what you think about the minor suggestions? And thanks again for all your efforts here, much appreciated.

[kanecko]

If I understood you correctly, you want to publish this version already. That's fine by me :)

If that is the case, I will open a new issue about the cropping and removing some images.
Additionally, I want to use the ".. warning::" and ".. note::" notations at two places.

[phillxnet]

@kanecko Re:

If I understood you correctly, you want to publish this version already. That's fine by me :)

Yes, I think now that we have covered the suggestions I'll give it one last build / format test and get it out there I think. That way folks can benefit form the work you've done to-date.

If that is the case, I will open a new issue about the cropping and removing some images.
Additionally, I want to use the ".. warning::" and ".. note::" notations at two places.

Sounds good. I just didn't see those as show-stoppers. Exactly detailing stuff that may not age well can be distracting.

I'll give what we have now, post your considerations of my suggestions a quick re-test.

[phillxnet]

PRODUCTION published