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

PK-Docs 1.0: How-To Guides Development Epic #80

Open
8 tasks
CryptoTotalWar opened this issue Jun 28, 2024 · 1 comment
Open
8 tasks

PK-Docs 1.0: How-To Guides Development Epic #80

CryptoTotalWar opened this issue Jun 28, 2024 · 1 comment
Assignees
Labels
design Requires design (architecture, protocol, specification and task list requires further work) documentation Improvements or additions to documentation enhancement New feature or request r&d:polykey:supporting activity Supporting core activity

Comments

@CryptoTotalWar
Copy link
Collaborator

CryptoTotalWar commented Jun 28, 2024

Goals and Objectives

Objective: Develop a comprehensive set of How-To Guides that enable users to leverage Polykey’s features in diverse real-world scenarios. The guides will be designed to be tool-agnostic where possible, emphasizing the application of Polykey as a whole rather than focusing separately on CLI or Core Library functionalities.
Got it, the focus will be on creating a unified set of How-To Guides for Polykey that encompass various real-world use cases involving both the Polykey-CLI and Polykey-Core Library, without segmenting them by the specific tool. This approach ensures the guides are broadly applicable and accessible, providing valuable insights into using Polykey across different scenarios.

Specific Goals:

  • Comprehensive Coverage: Cover a broad range of scenarios that reflect the diverse applications of Polykey in various operational and development environments.
  • User-Centric Content: Ensure each guide addresses specific user needs and enhances their ability to utilize Polykey effectively.
  • Actionable Guidance: Provide clear, practical steps that users can follow to achieve specific outcomes.
  • Adaptability and Flexibility: While focusing on specific tasks, allow for adaptations that users might need to make in different environments or with slightly different setups.

Potential Topics and Evaluation for How-To Guides

This section will list potential topics for the How-To Guides, which will be evaluated based on user demand, relevance, and technical feasibility. This dynamic list will be updated as new needs are identified and as Polykey evolves.

Topics Under Consideration:

  • 1. Securing Development Environments: How to securely manage secrets in development environments using Polykey.
  • 2. Automating Secret Management in CI/CD Pipelines: Integrating Polykey to manage secrets in CI/CD workflows effectively.
  • 3. Service Deployment with Cloud Services: Using Polykey to handle secrets in cloud service deployments (e.g., AWS ECS, Kubernetes).
  • 4. Employee Lifecycle Management: Managing secrets access as employees onboard and offboard.
  • 5. Integrating Polykey with Enterprise Systems: How to use Polykey with existing enterprise systems for centralized secrets management.
  • 6. Cryptographic Key Rotation and Management: Best practices for managing and rotating cryptographic keys in Polykey.
  • 7. Using Polykey in Microservices Architectures: Managing secrets in a microservices architecture with Polykey.

Confirmed Topics

  • How to replace dotenv library usage with Polykey

Specifications for Implementation

Once a topic is approved based on its evaluation:

  • Guide Development Plan: Outline the objectives, structure, and content of the guide, including any necessary technical examples or diagrams.

Linking and Tracking

  • Sub-Issues for Each Guide: Create detailed sub-issues for the development of each How-To Guide once it is approved. These sub-issues will facilitate focused development and allow for detailed tracking and management.
@CryptoTotalWar CryptoTotalWar added design Requires design (architecture, protocol, specification and task list requires further work) enhancement New feature or request labels Jun 28, 2024
@CryptoTotalWar CryptoTotalWar self-assigned this Jun 28, 2024
@CryptoTotalWar CryptoTotalWar added documentation Improvements or additions to documentation epic Big issue with multiple subissues labels Jun 28, 2024
Copy link

linear bot commented Jun 28, 2024

@CryptoTotalWar CryptoTotalWar changed the title PK-Docs: How-To Guides Development Epic PK-Docs 1.0: How-To Guides Development Epic Jun 28, 2024
@CMCDragonkai CMCDragonkai added r&d:polykey:supporting activity Supporting core activity and removed epic Big issue with multiple subissues labels Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design Requires design (architecture, protocol, specification and task list requires further work) documentation Improvements or additions to documentation enhancement New feature or request r&d:polykey:supporting activity Supporting core activity
Development

No branches or pull requests

2 participants