From ac42648e501bfc6bdac9525be92c1da30985e0f4 Mon Sep 17 00:00:00 2001 From: Vidit Kushwaha Date: Mon, 9 Dec 2024 11:55:47 +0000 Subject: [PATCH 1/2] Updated contributing.md for sistent documentation Signed-off-by: Vidit Kushwaha --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6b43c067294..2510c3f47851 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,6 +5,7 @@ We are beyond excited to see that you want to contribute! We would love to accep - [Before You Get Started](#before-you-get-started) - [Contributing to Layer5 Projects](#contributing-to-layer5-projects) - [Contributing to Layer5's Blogs](#contributing-to-layer5s-blogs) +- [Contributing to Layer5's Sistent documentation](#contributing-to-layer5s-sistent-documentation) - [How to Contribute](#how-to-contribute) - [Prerequisites](#prerequisites) - [Set up your Local Development Environment](#set-up-your-local-development-environment) @@ -129,6 +130,21 @@ If you'd like to contribute a post to layer5.io/blog, please open an Issue and s 3. Follow the instructions included in the news template and name the new file after the title of the news article. 4. Entries will be listed in chronological order automatically. +## Contributing to Layer5's Sistent documentation + +If you'd like to contribute a post to layer5.io/projects/sistent/components. start by selecting the area/sistent label in the [#GitHub issue tracker](https://github.com/layer5io/layer5/labels/project%2Fsistent). We've streamlined the process by introducing a dynamic page creation workflow, simplifying the addition of new pages and ensuring a consistent structure for all contributions. + +### Adding Sistent Component +1. All content is managed in a centralized file: + ``` + src/sections/Projects/Sistent/components/content.js + ``` +2. To add a new page, simply update this `content.js` file with the necessary details. +3. The system will dynamically generate pages based on this content and handle routing automatically. + +### Example +Refer to the **Button component** in the Sistent Library for an example of how to structure the content. + # Common Types of Site Contributions The following list of instructions pertains to commonplace site updates by contributors. From 6d7df3a07495c89354d257ac394c7686c0349640 Mon Sep 17 00:00:00 2001 From: Vidit Kushwaha Date: Thu, 12 Dec 2024 11:02:15 +0000 Subject: [PATCH 2/2] add general contribution and documentation guidelines for Sistent Signed-off-by: Vidit Kushwaha --- CONTRIBUTING.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2510c3f47851..ffce62888d59 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ We are beyond excited to see that you want to contribute! We would love to accep - [Before You Get Started](#before-you-get-started) - [Contributing to Layer5 Projects](#contributing-to-layer5-projects) - [Contributing to Layer5's Blogs](#contributing-to-layer5s-blogs) -- [Contributing to Layer5's Sistent documentation](#contributing-to-layer5s-sistent-documentation) +- [Contributing to Layer5's Sistent](#contributing-to-layer5s-sistent) - [How to Contribute](#how-to-contribute) - [Prerequisites](#prerequisites) - [Set up your Local Development Environment](#set-up-your-local-development-environment) @@ -130,20 +130,36 @@ If you'd like to contribute a post to layer5.io/blog, please open an Issue and s 3. Follow the instructions included in the news template and name the new file after the title of the news article. 4. Entries will be listed in chronological order automatically. -## Contributing to Layer5's Sistent documentation +# Contributing to Layer5's Sistent -If you'd like to contribute a post to layer5.io/projects/sistent/components. start by selecting the area/sistent label in the [#GitHub issue tracker](https://github.com/layer5io/layer5/labels/project%2Fsistent). We've streamlined the process by introducing a dynamic page creation workflow, simplifying the addition of new pages and ensuring a consistent structure for all contributions. +If you'd like to contribute to Sistent, start by selecting the project/sistent label in the [#GitHub issue tracker](https://github.com/layer5io/layer5/labels/project%2Fsistent). + +### General Contribution Guidelines + +1. Select the [project/sistent](https://github.com/layer5io/layer5/labels/project%2Fsistent) label in the GitHub issue tracker. +1. Navigate to the relevant directory, such as: + ``` + src/sections/Projects/Sistent + ``` + > Note: For other parts of the project, the file path may vary. Ensure you're working in the correct file associated with the area you're contributing to. +1. Add or update content. The system dynamically generates pages and routes to maintain consistency. ### Adding Sistent Component -1. All content is managed in a centralized file: + +We've streamlined the process by introducing a dynamic page creation workflow, simplifying the addition of new pages and ensuring a consistent structure for all contributions. + +1. Navigate to the relevant directory, such as: + ``` + src/sections/Projects/Sistent + ``` +1. To add a new page, simply update this `content.js` file with the necessary details. All content is managed in a centralized file: ``` src/sections/Projects/Sistent/components/content.js ``` -2. To add a new page, simply update this `content.js` file with the necessary details. -3. The system will dynamically generate pages based on this content and handle routing automatically. +1. The system will dynamically generate pages based on this content and handle routing automatically. ### Example -Refer to the **Button component** in the Sistent Library for an example of how to structure the content. +Refer to the [**Button component**](https://layer5.io/projects/sistent/components/button) in the Sistent Library for an example of how to structure the content. # Common Types of Site Contributions