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

PD-1728 / 25.10 / Pd 1728 reorganize apps main index #3498

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

micjohnson777
Copy link
Contributor

This PR reorganizes the content originally in the /TruenasApps/_index.md article by moving procedure or instruction related content into a new aricle ManagingApps.md, and updating the UsingTrains.md article content.

It also updates the AppsDataset.md snippet by removing the ACL procedure content and replacing it with redirection to instructions in individual app tutorials. This change to keep the main apps index about apps and not including procedural information.

It updates the UsingTrains.md content to replace duplicated instructions and add some content also in the main apps index file.

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.

This commit updates the new ManagingApps.md article with tutorial content removed from the main /TruenasApps/_index.md article.
It updates the content in the UsingTrains.md article, and the AppsDatasets.md snippet.
This commit fixes issues with links, frontmatter, and other issues discovered during a local build.
@micjohnson777 micjohnson777 requested a review from a team as a code owner February 11, 2025 18:50
@bugclerk bugclerk changed the title Pd 1728 reorganize apps main index PD-1728 / 25.10 / Pd 1728 reorganize apps main index Feb 11, 2025
@bugclerk
Copy link
Contributor

@linzi-ix linzi-ix added the Technical Writer Review (LM) A technical writer is reviewing the PR. label Feb 12, 2025
Copy link
Contributor

@linzi-ix linzi-ix left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

three minor typos/suggestions :) great job!

content/TruenasApps/ManagingApps.md Outdated Show resolved Hide resolved
content/TruenasApps/ManagingApps.md Show resolved Hide resolved
content/TruenasApps/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@DjP-iX DjP-iX left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way I was originally picturing this, and I think the way the ticket lays it out, is that:

  1. Discover Screen, Installing Apps and Installing Custom Apps would go in the Managing TrueNAS Apps article.

  2. Then Setting Up the Apps Service would stay in the index, since that's more of a general topic.

  3. The Managing App Trains article is not needed as a standalone URL. Anything not already covered in /truenasapps/#app-trains can be added there and then the UsingTrains.md file can be deleted and an alias added to the apps index.

content/TruenasApps/ManagingApps.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Technical Writer Review (LM) A technical writer is reviewing the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants