Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Documentation #10

Copy link
Copy link
@mwarman

Description

@mwarman
Issue body actions

Describe the story

Provide a clear description of the new feature or improvement to existing functionality.

Create or update the project documentation for clarity and simplicity.

  • Create a "DevOps Guide" which describes the GitHub Actions workflows.
    • Document the use of GitHub Actions for project DevOps automation.
    • Summarize the workflows in the project and how they are configured via GitHub Actions variables and secrets.
  • Simplify the Infrastructure Guide in the project documentation.
    • Reduce the level of detail regarding the provisioned infrastructure.
    • Describe the stacks and the purpose of each stack.
    • If appropriate, list key stack resources in tabular format.
    • The infrastructure configuration will be moved to a separate "Configuration Guide" so that does not need to be duplicated in the Infrastructure Guide.
    • No need to discuss CI/CD or DevOps in this guide, because that will have a dedicated "DevOps Guide".

Acceptance criteria

  • Clear and purposeful documentation written for a technical audience
  • Documentation is not duplicated between README files and purpose-written documentation in the /docs directory.
  • Documentation in the /docs directory has a simple README that serves as a table of contents. This document is brief and serves mainly as a place to link through to the documents in the /docs directory.

Additional context

Add any other context about the story here.

Reactions are currently unavailable

Metadata

Metadata

Assignees

Labels

enhancementNew feature or requestNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.