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: Break out the Syntax Reference into individual pages #14289

Open
jkodroff opened this issue Mar 6, 2025 · 0 comments · May be fixed by #14634
Open

ESC: Break out the Syntax Reference into individual pages #14289

jkodroff opened this issue Mar 6, 2025 · 0 comments · May be fixed by #14634
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

The Syntax Reference was created early in ESC's lifecycle. Now that ESC is a top-level member of the platform, we should document ESC environment syntax in a more refined way that is easier to read.

Some notes:

Maybe consider combining the basic syntax in the same section as the integration/provider reference, e.g. "Environments Syntax Reference" or something like that.

@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
@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
@komalali komalali self-assigned this Mar 24, 2025
@jkodroff jkodroff linked a pull request Apr 1, 2025 that will close this issue
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

Successfully merging a pull request may close this issue.

3 participants