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

Add section headers to the navigation in the left sidebar #1695

Open
anna-geller opened this issue Sep 4, 2024 · 1 comment
Open

Add section headers to the navigation in the left sidebar #1695

anna-geller opened this issue Sep 4, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation kind/website Website-related change

Comments

@anna-geller
Copy link
Member

anna-geller commented Sep 4, 2024

We want to add section headers that will serve as categories for the documentation to make finding the right information easier. Instead of further nesting the docs, the headers will make it easier to highlight the right sections of the docs for any stage of the adoption (getting started, building with kestra, managing kestra, scaling, etc...)

Figma: https://www.figma.com/design/g8Di3M1gbajOjOqp0ZrzXO/02_Kestra.io?node-id=12960-13588&t=Ue3jxy4m9dwBEuud-4

To determine which section will be shown under which category, we can extend this part

docs/nuxt.config.ts

Lines 131 to 136 in 9aa4718

runtimeConfig: {
public: {
siteUrl: process.env.NUXT_PUBLIC_SITE_URL || 'https://kestra.io',
apiUrl: process.env.NUXT_PUBLIC_API_URL || DEFAULT_KESTRA_API_URL,
}
},

with the specification of sections:

runtimeConfig: {
    public: {
        siteUrl: process.env.NUXT_PUBLIC_SITE_URL || 'https://kestra.io',
        apiUrl: process.env.NUXT_PUBLIC_API_URL || DEFAULT_KESTRA_API_URL,
        docs: {
            sections: {
                "Getting Started with Kestra": [
                    "Quickstart",
                    "Tutorial",
                    "Architecture",
                    "Installation Guide",
                    "User Interface",
                    "Video Tutorials"
                ],
                "Build with Kestra": [
                    "Concepts",
                    "Workflow Components",
                    "Expressions",
                    "Version Control & CI/CD",
                    "Plugin Developer Guide",
                    "How-to Guides"
                ],
                "Scale Kestra": [
                    "Enterprise Edition",
                    "Task Runners",
                    "Worker Groups",
                    "Best Practices"
                ],
                "Manage Kestra": [
                    "Administrator Guide",
                    "Configuration Guide",
                    "Migration Guide",
                    "Terraform Provider",
                    "API Reference"
                ]
            }
        }
    }
}

(credits to @wrussell1999 for all the work below, I'm only opening an issue for tracking)

@anna-geller anna-geller added documentation Improvements or additions to documentation kind/website Website-related change labels Sep 4, 2024
@anna-geller
Copy link
Member Author

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation kind/website Website-related change
Projects
Status: Backlog
Development

No branches or pull requests

3 participants