You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-25Lines changed: 23 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,6 @@ To help you get started on contributing to Layer5 projects, refer to the [Layer5
39
39
40
40
Before **creating** an Issue i.e for `features`/`bugs`/`improvements` please follow these steps:
41
41
42
-
43
42
1. Search existing Issues before creating a new Issue (look to see if the Issue has already been created).
44
43
1. If it doesn't exist create a new Issue giving as much context as possible (please take note and select the correct Issue type, for example `bug`, `documentation` or `feature`.
45
44
1. If you wish to work on the Issue once it has been triaged, please include this in your Issue description.
@@ -50,12 +49,12 @@ Before working on an existing Issue please follow these steps:
50
49
51
50
1. Comment asking for the Issue to be assigned to you.
52
51
1. To best position yourself for Issues assignment, we recommend that you:
53
-
1. Confirm that you have read the CONTRIBUTING.md.
54
-
1. Have a functional development environment (have built and are able to run the project).
55
-
1. Convey your intended approach to solving the issue.
56
-
1. Put each of these items in writing in one or more comments.
52
+
1. Confirm that you have read the CONTRIBUTING.md.
53
+
1. Have a functional development environment (have built and are able to run the project).
54
+
1. Convey your intended approach to solving the issue.
55
+
1. Put each of these items in writing in one or more comments.
57
56
1. After the Issue is assigned to you, you can start working on it.
58
-
1. In general, **only** start working on this Issue (and open a Pull Request) when it has been assigned to you. Doing so will prevent confusion, duplicate work (some of which may go unaccepted given its duplicity), incidental stepping on toes, and the headache involved for maintainers and contributors alike as Issue assignments collide and heads bump together.
57
+
1. In general, **only** start working on this Issue (and open a Pull Request) when it has been assigned to you. Doing so will prevent confusion, duplicate work (some of which may go unaccepted given its duplicity), incidental stepping on toes, and the headache involved for maintainers and contributors alike as Issue assignments collide and heads bump together.
59
58
1. Reference the Issue in your Pull Request (for example `This PR fixes #123`). so that the corresponding Issue is automatically closed upon merge of your Pull Request.
60
59
61
60
> Notes:
@@ -81,7 +80,6 @@ We welcome everyone to review Pull Requests. It is a great way to learn, network
81
80
- Do not repeat feedback, this creates more noise than value (check the existing conversation), use GitHub reactions if you agree/disagree with a comment
82
81
- Do not blindly approve Pull Requests to improve your GitHub contributors graph
83
82
84
-
85
83
## Style Guide
86
84
87
85
The Layer5 website is hosted in this repository and is built using Gatsbyjs. Before opening a Pull Request, please review the [design doc](https://docs.google.com/document/d/1rvUZy2_S1a2_14BAQIg6b9cMhUuu04kYzkOPDPaPptI/edit#) to learn more about the structure of the website. Once a Pull Request has been submitted, a preview deployment will be built and made available to you and other contributors on your PR to review.
@@ -138,7 +136,7 @@ If you'd like to contribute to [Sistent](https://github.com/layer5io/sistent), a
138
136
```
139
137
src/sections/Projects/Sistent
140
138
```
141
-
> 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.
139
+
> 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.
142
140
1. Add or update content. The system dynamically generates pages and routes to maintain consistency.
143
141
144
142
### Adding Sistent Component
@@ -148,14 +146,15 @@ We've streamlined the process by introducing a dynamic page creation workflow, s
148
146
1. Navigate to the relevant directory, such as:
149
147
```
150
148
src/sections/Projects/Sistent
151
-
```
149
+
```
152
150
1. To add a new page, simply update this `content.js` file with the necessary details. All content is managed in a centralized file:
1. The system will dynamically generate pages based on this content and handle routing automatically.
157
155
158
156
### Example
157
+
159
158
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.
160
159
161
160
# Common Types of Site Contributions
@@ -502,7 +501,7 @@ Make sure you have the following prerequisites installed on your operating syste
502
501
503
502
### Make Targets
504
503
505
-
Layer5 uses a `Makefile` that defines a set of rules and instructions (called **targets**) for creating, updating, and running parts of the project. Each target abstracts the underlying commands and logic, allowing to execute complex workflows using a simple `make <target>` command.
504
+
Layer5 uses a `Makefile` that defines a set of rules and instructions (called **targets**) for creating, updating, and running parts of the project. Each target abstracts the underlying commands and logic, allowing to execute complex workflows using a simple `make <target>` command.
506
505
507
506
> **Note:** While using the make command on Windows, there sometimes arises an error in identifying the command even after it is installed (unrecognized command), this is because the PATH for the binary might not be set correctly.
508
507
@@ -516,13 +515,13 @@ make
516
515
517
516
Environment variables are named values used to configure how an application behaves in different environments without modifying the code.
518
517
519
-
| Variable | Possible Values | Description |
520
-
|---------|----------------|------------|
521
-
|`BUILD_FULL_SITE`|`true`, `false`| When set to `true`, enables a full site build including all collections. If not explicitly set to `true`, the project defaults to a lightweight build. |
522
-
|`LITE_BUILD_PROFILE`|`content`, `core`| Selects which collections are excluded when `BUILD_FULL_SITE=false`. `core` is the default for `make site`, `npm start`, and `npm run dev`, while `content` keeps blog, news, events, and resources enabled. |
523
-
|`BUILD_COLLECTIONS_EXCLUDE`| comma-separated collection names | Adds extra collections to exclude from a lightweight build without editing project files. |
524
-
|`NODE_ENV`|`development`, `production`| Determines the build and rendering mode used by Gatsby. This is automatically set by Gatsby. <br><br>• `development` - Uses **Deferred Static Generation (DSG)** i.e pages built on demand for faster startup. <br>• `production` - Uses **Server-Side Rendering (SSR)** i.e pages rendered on each request for fresh content. |
525
-
|`CI`|`true`, `false`| Indicates that the build is running in a **Continuous Integration (CI)** environment (e.g., GitHub Actions). When set to `true`, special logic is applied to page paths and redirects for GitHub Pages compatibility. This is typically set automatically by the CI system and does not need to be configured manually. |
|`BUILD_FULL_SITE`|`true`, `false`| When set to `true`, enables a full site build including all collections. If not explicitly set to `true`, the project defaults to a lightweight build.|
521
+
|`LITE_BUILD_PROFILE`|`content`, `core`| Selects which collections are excluded when `BUILD_FULL_SITE=false`. `core` is the default for `make site`, `npm start`, and `npm run dev`, while `content` keeps blog, news, events, and resources enabled.|
522
+
|`BUILD_COLLECTIONS_EXCLUDE`| comma-separated collection names | Adds extra collections to exclude from a lightweight build without editing project files. |
523
+
|`NODE_ENV`|`development`, `production`| Determines the build and rendering mode used by Gatsby. This is automatically set by Gatsby. <br><br>• `development` - Uses **Deferred Static Generation (DSG)** i.e pages built on demand for faster startup. <br>• `production` - Uses **Server-Side Rendering (SSR)** i.e pages rendered on each request for fresh content. |
524
+
|`CI`|`true`, `false`| Indicates that the build is running in a **Continuous Integration (CI)** environment (e.g., GitHub Actions). When set to `true`, special logic is applied to page paths and redirects for GitHub Pages compatibility. This is typically set automatically by the CI system and does not need to be configured manually.|
> V5 is a release we cut explicitly for React 18 support (Hence the major upgrade, this was a breaking change, the webpack fix would not work as we are using React 18 new APIs), we are sticking with V4 for React 17 and under compatibility, using V4 has no functional difference outside of React version compatibility.
703
+
> This warning was common in earlier local setups when dependency trees were out-of-sync with React 18 support.
707
704
708
705
Layer5 currently using:
709
706
"react-accessible-accordion": "^5.0.0"
710
-
react": "^17.0.2"
707
+
"react": "^18.2.0"
708
+
"gatsby": "^5.16.1"
711
709
712
710
To clear the warning:
713
-
Upgrade the `react`package to ^18. However upgrading may introduce too many breaking changes and complexity.
711
+
Reinstall dependencies (`make setup`) and ensure your local dependency tree aligns with this repository's `package.json`.
714
712
715
713
---
716
714
@@ -722,7 +720,7 @@ Where/When:
722
720
723
721
- In terminal: after `npm start` and loading page
724
722
725
-
Reason: In this version of Gatsby (4.20), the file:
723
+
Reason: In older Gatsby 4.x versions, the file:
726
724
`node_modules/gatsby/cache-dir/head/head-export-handler-for-ssr.js` is missing code to assign `key` prop to each head tag included in the `SEO` component.
0 commit comments