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

ESC: Clean up Integrations Hierarchy #14290

Open
jkodroff opened this issue Mar 6, 2025 · 2 comments
Open

ESC: Clean up Integrations Hierarchy #14290

jkodroff opened this issue Mar 6, 2025 · 2 comments
Assignees
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features

Comments

@jkodroff
Copy link
Member

jkodroff commented Mar 6, 2025

We have two types of things intermingled in "Integrations" in the ESC codes:

"Dynamic login credentials", "Dynamic secrets", "Rotated secrets", and the deeply nested pulumi-stacks integration (or are they called providers still?) all make sense to be grouped together. They are special syntax that you use when authoring an Environment. They could be categorized as they are now (probably better?) or flat, but they all go together because they are true, deep integrations.

They could also be grouped with basic syntax if we break those examples out, per #14289.

The rest of the stuff in this section are more akin to examples. They are ways to use basic ESC functionality (like file outputs and the fact you can use ESC with any CLI program) to work with other tools and solve larger problems. These might be better grouped under "Using ESC with..." or something like that.

"GitHub" should be retitled "GitHub Actions" to make it more clear. Maybe even move GitHub Actions to the top level since it's not an example and it's not an integration like e.g. aws-login.

Image
@jkodroff jkodroff added the needs-triage Needs attention from the triage team label Mar 6, 2025
@github-project-automation github-project-automation bot moved this to 🤔 Triage in Docs 📚 Mar 6, 2025
@jkodroff jkodroff assigned jkodroff and interurban and unassigned jkodroff Mar 6, 2025
@cleverguy25
Copy link
Contributor

Before we more organized like how you mention. People were not finding the docs. A lot of this organization was learning from the common patterns of how we see our competitors organize, not by type of integration and internal details of how an integration works but by capability.

@interurban interurban added area/docs Improvements or additions to documentation kind/enhancement Improvements or new features and removed needs-triage Needs attention from the triage team labels Mar 6, 2025
@jkodroff
Copy link
Member Author

jkodroff commented Mar 6, 2025

@cleverguy25 What would you think of keeping the reference materials (e.g. aws-login) in one place, and creating a new series of "Using ESC with..." and then AWS/GCP/Docker/K8s, etc.? That keeps us in line with diataxis (which I think is a good way to organize information) while still being end-use oriented.

The "new series" wouldn't be entirely new - we already have what I was imagining with Docker: use case oriented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/enhancement Improvements or new features
Projects
Status: 🤔 Triage
Development

No branches or pull requests

3 participants