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: write our own tutorials #151

Open
JanMa opened this issue Feb 20, 2024 · 3 comments
Open

docs: write our own tutorials #151

JanMa opened this issue Feb 20, 2024 · 3 comments
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JanMa
Copy link
Member

JanMa commented Feb 20, 2024

The current docs contain many links to Vault tutorials in the HashiCorp developer portal. Unfortunately the sources for these tutorials are not public and I don't think it's save for us to just copy the content from the Hashi website and put it into our docs verbatim.

So instead we should write our own tutorials for at least some topics. I don't think we need to rewrite all ~80 of them, but things like getting started, HA, production hardening and an how to use dynamic DB secrets are definitely needed in my opinion.

@JanMa JanMa added the bug Something isn't working label Feb 20, 2024
@naphelps naphelps added good first issue Good for newcomers help wanted Extra attention is needed labels Feb 21, 2024
@naphelps naphelps added this to the GA milestone Feb 21, 2024
@axelsimon
Copy link

Are you sure?
https://developer.hashicorp.com/vault/docs/what-is-vault has a "Edit this page on GitHub" link at the bottom which leads to https://github.com/hashicorp/vault/blob/main/website/content/docs/.

One would need to properly check, but if the website and docs were under the same license as the rest of the project, up until hashicorp/vault#22290 on the 11th of August, the docs would fall under the MPL license, meaning the version of the docs at that time could be imported into the OpenBao project.

As usual, IANAL and IANYL etc.

@cipherboy
Copy link
Member

cipherboy commented Mar 4, 2024

@axelsimon Yes, that link is for the documentation which is contained under our website folder. @JanMa has already done a lot of great work on forking and updating that :-)

Check out this link instead: https://developer.hashicorp.com/vault/tutorials/secrets-management/pki-engine

(see /tutorials/ in the URL versus /docs/)

This was in a different (internal) repo and don't have an Edit on GitHub link, e.g., hashicorp/vault#22761 which discusses this... These tutorials don't have a license associated with them and so likely would have to be rewritten.

@axelsimon
Copy link

Ah, i see. Thanks for taking the time to clarify!
Indeed, if there is no license associated, then plain copyright applies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants