Skip to content

Documentation📄: Flesh out section on secrets usage #625

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

Open
joewxboy opened this issue Apr 9, 2025 · 2 comments · May be fixed by #630
Open

Documentation📄: Flesh out section on secrets usage #625

joewxboy opened this issue Apr 9, 2025 · 2 comments · May be fixed by #630
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@joewxboy
Copy link
Member

joewxboy commented Apr 9, 2025

What is the current documentation state?

Existing documentation and examples only show using a single secret, and do not incorporate service def and deployment policy template boilerplate structure around secrets.

Where is this stated?

No response

Why do you want to improve the statement?

See service-postgresql at https://github.com/joewxboy/service-postgresql for more comprehensive usage,
and issue open-horizon-services/service-postgresql#5 for problem exposing secrets values to deployment environment variables.

Proposed Statement

No response

Additional context.

No response

@joewxboy joewxboy added the documentation Improvements or additions to documentation label Apr 9, 2025
@joewxboy joewxboy self-assigned this May 5, 2025
@joewxboy
Copy link
Member Author

joewxboy commented May 5, 2025

The pages about secrets include:

@joewxboy
Copy link
Member Author

joewxboy commented May 5, 2025

We need a comprehensive plan for reorganizing the secrets management documentation. The key aspects of this plan are:

  • Logical Progression: The documentation will flow from basic concepts to advanced topics, making it accessible to both new and experienced users.
  • Clear Structure: The content is organized into a main page and four focused subpages, each addressing specific aspects of secrets management.
  • Practical Focus: The structure emphasizes practical implementation while maintaining necessary technical depth.
  • Integration of Examples: The Hello Secret World example will be better integrated into the documentation flow rather than being a separate entity.

Any proposed structure should address several key improvements:

  • Better Onboarding: New users can start with the Quick Start Guide and basic concepts.
  • Clearer Organization: Each topic has a dedicated section with related information grouped together.
  • Improved Reference: The CLI commands and technical details are organized for easy reference.
  • Enhanced Security: Security considerations are given more prominence.
  • Practical Examples: Real-world use cases and examples are integrated throughout.

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
1 participant