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

Docs: flowchart/diagram for the overall build & deployment process #104

Open
leo-smi opened this issue Dec 19, 2024 · 1 comment
Open

Docs: flowchart/diagram for the overall build & deployment process #104

leo-smi opened this issue Dec 19, 2024 · 1 comment
Labels
Category: Documentation Improvements or additions to documentation

Comments

@leo-smi
Copy link

leo-smi commented Dec 19, 2024

I know it seems fancy but i suggest create a flowchart/diagram to represent the idea. Some people are more visual than other or maybe have ADHD or similar.

@ncoghlan
Copy link
Collaborator

ncoghlan commented Dec 20, 2024

As in something like the following (in actual diagram form)?:

  • venvstacks.toml -> (venvstacks lock) -> locked layer requirements files & metadata
    -> (venvstacks build) -> built layer environments ->

    • -> (venvstacks local-export) -> locally deployed environments

    • -> (venvstacks publish) -> layer archives & metadata -> (application specific distribution mechanism)

      • -> (unpack archives and run post-installation scripts) -> remotely deployed environments

That seems like a worthwhile addition to me. When I've wanted similar things in the past, I've used http://blockdiag.com/en/index.html to allow them to be expressed as text directives in the Sphinx docs rather than creating and maintaining the diagrams by hand.

(Tangentially related to #99, since that would explain what's involved in the "unpack archive and run post-installation script" step)

@ncoghlan ncoghlan added the Category: Documentation Improvements or additions to documentation label Dec 20, 2024
@ncoghlan ncoghlan changed the title Create a generic flowchart/digram for the docs Docs: Create a flowchart/diagram for the overall build & deployment process Dec 20, 2024
@ncoghlan ncoghlan changed the title Docs: Create a flowchart/diagram for the overall build & deployment process Docs: flowchart/diagram for the overall build & deployment process Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants