PD-1556 / 25.04 / Pd 1556 revise app tutorial template #3292
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR updates the apps tutorial template and changes embedded instructions to commented-out content instead of using code blocks that didn't render well. It also updates the contributing article to provide more instructions on using the tutorial template.
bugclerk
changed the title
|
Making this ready for review but still open for edits. |
DjP-iX
requested changes
Dec 2, 2024
There was a problem hiding this comment.
Pushed my changes seperately.
There is one line I wasn't able to interpret. Seems like a typo or paste/delete confusion?
The snippet names documented in the index file also need review, since I found a number in the template that were still using the outdated snippet name.
DjP-iX
reviewed
Dec 2, 2024
fix copy/paste error in line 160
Modified the description for the BeforeYouBeginStableApps.md snippet, removing the new user and add dataset bullet points, and added the new snippet BeforeYouBeginAddAppDatasets.md to the list. This snippet is created in another PR, PD-1626 that modifies the Nextcloud tutorial.
|
Verified the list of snippets, and made a modification to the list in the last commit to this PR. |
|
I've noticed a few things I want to change in addition to the feedback already received so I'm making this a draft to make those changes |
This commit updates the Contributing section _index.md content with the new snippets. It updates the template with new/improved content
|
Updated the contributing _index.md tables of snippets and the content in the template |
Add missing /expand tag to line 263
A few changes made to the template. Added internal link to storage configuration settings and added new commented-out text related to the InstallWizardStorageConfig2.md snippet.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the /Contributing/Applications/_index.md and AppArticleTemplate.md files.
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.