Skip to content

Commit

Permalink
Merge pull request #6118 from Vidit-Kushwaha/update/contributing
Browse files Browse the repository at this point in the history
Updated contributing.md for sistent documentation
  • Loading branch information
sudhanshutech authored Dec 15, 2024
2 parents b3b6908 + 6d7df3a commit 8c38557
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](#contributing-to-layer5s-sistent)
- [How to Contribute](#how-to-contribute)
- [Prerequisites](#prerequisites)
- [Set up your Local Development Environment](#set-up-your-local-development-environment)
Expand Down Expand Up @@ -129,6 +130,37 @@ 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

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

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
```
1. The system will dynamically generate pages based on this content and handle routing automatically.

### Example
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

The following list of instructions pertains to commonplace site updates by contributors.
Expand Down

0 comments on commit 8c38557

Please sign in to comment.