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

DOCS add secure application access draft #2450

Merged
merged 9 commits into from
Jan 31, 2024

Conversation

fabianmuehlberger
Copy link
Contributor

I started writing a tutorial regarding security of TrueNAS applications.

I would have created an Issue for my proposal but created a fork and PR instead. Furthermore, I am not sure if this belongs in master since it is still a draft, but wanted some feedback. Since I am relatively new to TrueNAS it is likely that my contribution contains errors.

I for now I created a _index.md with the content, under Apps/AppSecurity and stored the images under src/static/SCALE/Apps. In frontmatter I added the author (me) and set draft: true

Guidance for further work is appreciated!

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.

@fabianmuehlberger fabianmuehlberger requested a review from a team as a code owner January 30, 2024 13:56
@fabianmuehlberger fabianmuehlberger changed the title DOCS add secure application acces draft DOCS add secure application access draft Jan 30, 2024
@DjP-iX DjP-iX added the Technical Writer Review (DP) A technical writer is reviewing the PR. label Jan 30, 2024
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.

Thank you for the excellent contribution @fabianmuehlberger!

I've left a number of (largely stylistic) suggestions, but the overall procedure looks good.

Note that we're probably going to move this from an index to something like /apps/SecuringApps.md before publishing, but leaving it here for now will let you see the suggestions easier.

content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
@fabianmuehlberger
Copy link
Contributor Author

Hey @DjP-iX thank you for the prompt reply. Since I went through the process of setting up those applications (first time TrueNAS owner), I thought I write it down while I have it in memory.

Preferably, if you like, I would commit to e.g. "DEV DOC appsecurity" branch created by you. Otherwise, I can stay on my fork if you prefer that.

TY for the suggestions, I hope to implement them tomorrow.

Note that we're probably going to move this from an index to something like /apps/SecuringApps.md before publishing, but leaving it here for now will let you see the suggestions easier.

Regarding the doc structure, I intend to cover multiple ways of securing applications, including Cloudflare, Tailscale, etc. ideally in a more generalized approach, and with the help of the community.
I am not sure about the document structure, depending on the covered areas and apps, I think it should be split into different pages, for easier editing.

Best Fabian

Ty for the review

Co-authored-by: DjP-iX <133042991+DjP-iX@users.noreply.github.com>
@fabianmuehlberger
Copy link
Contributor Author

Regarding the image credit, I tried to use "caption"

{{< trueimage src="/images/SCALE/Apps/CloudflareTunnelOverview.jpg" alt="Cloudflare Tunnel Overview" id="Cloudflare Tunnel Overview" caption="cloudflare.com" >}} but that does not work. How should I give credit correctly?

@fabianmuehlberger
Copy link
Contributor Author

I am not sure how to add a relative ref to an anchor.

line 24: See [security]{{< relref "_index.md#additional-security-considerations" >}}

DjP-iX
DjP-iX previously requested changes Jan 31, 2024
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.

Looking good @fabianmuehlberger!

If you're planning to contribute additional articles on this subject, then I think we are fine to leave this as an index instead of an individual article.

content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
content/SCALE/SCALETutorials/Apps/AppSecurity/_index.md Outdated Show resolved Hide resolved
TY for fixing

Co-authored-by: DjP-iX <133042991+DjP-iX@users.noreply.github.com>
Copy link
Contributor Author

@fabianmuehlberger fabianmuehlberger left a comment

Choose a reason for hiding this comment

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

For splitting the document, I suggest, having everything related to a specific app (in that case, Cloudflare separated).

I would keep it as it is, until there is new content.

@DjP-iX DjP-iX merged commit 4868d21 into truenas:master Jan 31, 2024
3 checks passed
@DjP-iX
Copy link
Contributor

DjP-iX commented Jan 31, 2024

Thanks again @fabianmuehlberger!

This one is merged, but feel free to continue working in your fork and open a PR against our Master branch if you have any further changes. Likewise if you do write any further content for other apps/solutions. We'll be happy to see your contributions.

@fabianmuehlberger
Copy link
Contributor Author

Thank you for the support and lending me a hand! This was my first bigger contribution to a project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Technical Writer Review (DP) A technical writer is reviewing the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants