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

Commit code examples to repo #65

Open
pederhan opened this issue Oct 13, 2023 · 0 comments
Open

Commit code examples to repo #65

pederhan opened this issue Oct 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@pederhan
Copy link
Member

pederhan commented Oct 13, 2023

When writing the examples for the documentation, I have been saving them locally as separate files. I think it's useful to have code examples in the repository itself. Before I can commit my local files, I need to scrub them of all sensitive information and replace them with consistent os.getenv calls, which will allow all examples to be run with one set of environment variables (something like HARBOR_URL, HARBOR_USER, HARBOR_SECRET, etc.).

Additionally, the examples directory needs a README that suggests reading the actual documentation pages, because they provides additional context for each code example.

@pederhan pederhan added the documentation Improvements or additions to documentation label Oct 13, 2023
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

1 participant