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

Readme quick install unclear regarding included idP #2956

Open
xpufx opened this issue Nov 27, 2024 · 3 comments
Open

Readme quick install unclear regarding included idP #2956

xpufx opened this issue Nov 27, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@xpufx
Copy link

xpufx commented Nov 27, 2024

Would you please add a little blurb in the quick install with docker section making it clear that "an identity provider - zitadel - will be installed". I thought I could follow the quick install docs, THEN look at the advanced install with another idP section.

@Marcus1Pierce
Copy link

As far as I know, all the quick install tutorials from netbird docs and github readme all of them use the link https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh which contains the file name getting-started-with-zitadel.sh

@xpufx
Copy link
Author

xpufx commented Nov 28, 2024

Yes they do. That's even more confusing. Maybe I am daft but I was wondering why when I was trying to install netbird, i was using a getting started with zitadel script. I thought maybe netbird was called zitadel before and it was an old link.

@mgarces mgarces added documentation Improvements or additions to documentation and removed triage-needed labels Nov 29, 2024
@mgarces
Copy link
Contributor

mgarces commented Nov 29, 2024

We can try to clarify our documentation, thank your for this. On our docs we have two sections "Get Started" and "Self-Hosted NetBird", and they both contain the submenu "Getting Started"; do you think this also causes confusion @xpufx?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants