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

Add some more documentation for beginners #55

Open
theheckwr opened this issue Oct 6, 2022 · 2 comments
Open

Add some more documentation for beginners #55

theheckwr opened this issue Oct 6, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@theheckwr
Copy link

Having just begun my journey with openziti and ZAC it would be helpful to have some more documentation.
Having had an issue with the tunneler config (openziti/ziti-tunnel-sdk-c#508), I suggest to add some configuration help to the ZAC.
Some examples from the top of my head:

  • service configurations:
    • help the user to choose which config type to use (provide defaults?)
    • mark the optional/ required config options (if applicable use defaults)
  • identities: info that an identity can be used only once (at least that's my experience)

I hope this isn't too vague. If I can help anything please let me know, I'll try to find some time. 😉

@dovholuknf
Copy link
Member

Thanks for the issue! documenting the ZAC better is something we know we need to get through. Stay tuned, I'm sure we'll get around to it in the coming months

@JeremyTellier JeremyTellier self-assigned this Nov 7, 2022
@JeremyTellier JeremyTellier added the enhancement New feature or request label May 26, 2023
@qrkourier
Copy link
Member

relatedly: #283

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants