PD-1369 / 25.04 / Pd 1369 update custom app

[DjP-iX]

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

[micjohnson777]

Found some small style stuff and minor correction suggestions.
Also the UI ref content is reading too much like tutorial content. in a later version of the Custom App UI ref we should clean this up.
We should try to reuse the app snippets where possible. Again, we can review the tutorial content for opportunities to use she snippets where it fits. The tutorial appears to just be explaining how to populate the fields like the UI ref does. Suggest in a future version we keep this if they are required to deploy the app. Again this can be done at a later date.

Finally, and most important..... EXCELLENT work!

[micjohnson777]

Then search for all instances of dockerfile and apply capitalization. There is at least one instance of this.

…

On Thu, Oct 17, 2024 at 12:17 PM DjP-iX ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In content/TruenasApps/UsingCustomApp.md <#3123 (comment)> : > +A [Dockerfile](https://docs.docker.com/reference/dockerfile/) builds the Nextcloud image locally, rather than pulling from a remote repository. +You can use an existing Dockerfile or, as in the example, use [`dockerfile_inline`](https://docs.docker.com/reference/compose-file/build/#dockerfile_inline) to define the build commands as an inline string within the Compose file. They are proper nouns though. Dockerfile is the name of a specific thing. Compose is being used as the name of the [Docker] Compose software, not "compose," which is a verb. A Google search shows most other online docs (Docker or otherwise) are capitalizing Dockerfile — Reply to this email directly, view it on GitHub <#3123 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AWDR2RE22QE5AG5URWHK77LZ37PIXAVCNFSM6AAAAABPXGP5MSVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDGNZVG4YTCNJTGE> . You are receiving this because your review was requested.Message ID: ***@***.***>

[DjP-iX]

Found some small style stuff and minor correction suggestions. Also the UI ref content is reading too much like tutorial content. in a later version of the Custom App UI ref we should clean this up. We should try to reuse the app snippets where possible. Again, we can review the tutorial content for opportunities to use she snippets where it fits. The tutorial appears to just be explaining how to populate the fields like the UI ref does. Suggest in a future version we keep this if they are required to deploy the app. Again this can be done at a later date.

Finally, and most important..... EXCELLENT work!

I think I got some of this in the comments along the way, but to reiterate:

I see what you're saying about the UI ref reading a bit like tutorial content but I was trying not to reinvent the wheel where there was material I could reuse from the previous version. Like you said, we can address that next time we do a pass over this content.

I did try to use the app snippets, but in most cases they were written in a way that makes sense for catalog apps but doesn't apply to custom apps, had information that is relevant to catalog apps but doesn't apply to custom apps, or lacks Docker-specific information that doesn't really matter to the average user just installing catalog apps but does when installing a custom app. I did mine them for some language but I thought it would've made the custom app tutorial more confusing to use them as is.

And as far as the tutorial generally explaining how to fill in the fields and not leaving out fields that are not needed to install the app, I don't see how we can do any differently. We don't know which app they're installing or what fields are or are not relevant to deploy any given app. If I was looking for a tutorial for how to use the custom app wizard, I'd be looking for something that explains how it all works so I can decide how to adapt whatever app I'm attempting to install to those fields.

[micjohnson777]

Ready to go. All changes render correctly! Excellent work!

[bugclerk]

This PR has been merged and conversations have been locked.
If you would like to discuss more about this issue please use our forums or raise a Jira ticket.

[DjP-iX]

backport