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
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
34
34
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
25
-
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
25
+
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
19
19
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
- 📚 [Instructions for contributing to layer5-academy](https://github.com/layer5io/layer5-academy/blob/master/CONTRIBUTING.md)
26
+
- academy-template documentation [site](https://docs.layer5.io/cloud/academy/), [example](https://github.com/layer5io/academy-example/) and [theme](https://github.com/layer5io/academy-theme/)
25
27
- 🎨 Wireframes and [designs for Layer5 site](https://www.figma.com/file/5ZwEkSJwUPitURD59YHMEN/Layer5-Designs) in Figma [(open invite)](https://www.figma.com/team_invite/redeem/qJy1c95qirjgWQODApilR9)
28
+
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+25-24Lines changed: 25 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
# <aname="contributing">Contributing Overview</a>
2
2
Please do! Thanks for your help improving the project! :balloon:
3
3
4
-
All contributors are welcome. Please see the [newcomers welcome guide](https://layer5.io/community/newcomers) for how, where and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our [Code of Conduct](.CODE_OF_CONDUCT.md).
4
+
All contributors are welcome. Please see the [newcomers welcome guide](https://layer5.io/community/newcomers) for how, where and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md).
5
5
6
-
Not sure where to start? First, see the [newcomers welcome guide](https://docs.google.com/document/d/17OPtDE_rdnPQxmk2Kauhm3GwXF1R5dZ3Cj8qZLKdo5E/edit). Grab an open issue with the [help-wanted label](../../labels/help%20wanted) and jump in. Join the [Slack account](http://slack.layer5.io) and engage in conversation. Create a [new issue](/../../issues/new/choose) if needed. All [pull requests](/../../pulls) should reference an open [issue](/../../issues). Include keywords in your pull request descriptions, as well as commit messages, to [automatically close issues in GitHub](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
6
+
Not sure where to start? First, see the [newcomers welcome guide](https://layer5.io/community/newcomers). Grab an open issue with the [help-wanted label](../../labels/help%20wanted) and jump in. Join the [Slack account](http://slack.layer5.io) and engage in conversation. Create a [new issue](/../../issues/new/choose) if needed. All [pull requests](/../../pulls) should reference an open [issue](/../../issues). Include keywords in your pull request descriptions, as well as commit messages, to [automatically close issues in GitHub](https://help.github.com/en/github/managing-your-work-on-github/closing-issues-using-keywords).
@@ -13,20 +13,17 @@ Relevant coding style guidelines are the Go Code Review Comments and the Formatt
13
13
14
14
## Important Information
15
15
16
-
This repository serves as a content-only starter template for creating courses on the Layer5 Academy. Its primary purpose is to provide a clear example of how to structure learning paths.
16
+
This repository serves as the **official content repository**for Layer5's Academy learning platform, hosting all official learning paths, challenges, and certifications.
17
17
18
-
### Important Distinction: Content vs. Theme
19
-
- This Repository (academy-example): This is for content only.
20
-
- Theme Repository ([layer5io/academy-theme](https://github.com/layer5io/academy-theme/)): All visual elements, layouts, CSS, and Hugo logic are managed in the central layer5io/academy-theme repository.
21
18
22
19
### Detailed Guide
23
20
For a complete, step-by-step guide on how to create, structure, and publish a new learning path, please refer to our official documentation:
24
21
25
-
➡️ [Creating Your First Learning Path](https://docs.layer5.io/cloud/academy/creating-your-learning-path/)
Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host docs sites. Learn more about [Layer5's documentation framework](https://docs.google.com/document/d/17guuaxb0xsfutBCzyj2CT6OZiFnMu9w4PzoILXhRXSo/edit?usp=sharing). The process of contributing follows this flow:
Please contribute! Layer5 Academy uses Hugo and GitHub Pages to host the learning platform. Learn more about [Layer5's Academy platform development](https://docs.layer5.io/cloud/academy/platform-development/). The process of contributing follows this flow:
68
65
69
66
1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md)
70
-
1. In the local copy of your fork, navigate to the docs folder.
71
-
`cd docs`
67
+
1. In the local copy of your fork, navigate to the content folder.
68
+
`cd content`
72
69
1. Create and checkout a new branch to make changes within
73
70
`git checkout -b <my-changes>`
74
-
1. Edit/add documentation.
75
-
`vi <specific page>.md`
71
+
1. Edit/add learning content.
72
+
`vi <specific content>.md`
76
73
1. Run site locally to preview changes.
77
74
`make site`
78
75
1. Commit, [sign-off](#commit-signing), and push changes to your remote branch.
@@ -81,22 +78,26 @@ Please contribute! Layer5 documentation uses Jekyll and GitHub Pages to host doc
81
78
82
79
83
80
#### Tests
84
-
Users can now test their code on their local machine against the CI checks implemented using `make run-tests`.
81
+
Users can now test their local development setup using the provided Makefile commands.
85
82
86
-
To test code changes on your local machine, run the following command:
83
+
To test your local Academy setup, run the following commands:
87
84
```
88
-
make run-tests
85
+
# Install dependencies
86
+
make setup
87
+
88
+
# Start local development server
89
+
make site
89
90
```
90
91
91
-
#### Building Docker image
92
-
To build a Docker image of the project, please ensure you have `Docker` installed to be able to build the image. Now, run the following command to build the Docker image:
92
+
#### Building the Site
93
+
To build the Academy site for production, ensure you have `Hugo` and `Go` installed. Now, run the following command to build the site:
93
94
```sh
94
-
make docker
95
+
make build
95
96
```
96
97
97
-
### UI Lint Rules
98
+
### Content Guidelines
98
99
99
-
Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code.
100
+
Layer5 Academy follows specific content and formatting guidelines for consistency across all learning materials.
100
101
101
102
# <aname="maintaining"> Reviews</a>
102
103
All contributors are invited to review pull requests. See this short video on [how to review a pull request](https://www.youtube.com/watch?v=isLfo7jfE6g&feature=youtu.be).
@@ -114,4 +115,4 @@ This repository and site are available as open source under the terms of the [Ap
114
115
<p>The <ahref="https://layer5.io/community">Layer5 community</a> represents the largest collection of service mesh projects and their maintainers in the world.</p>
115
116
116
117
**Open Source First**
117
-
<p>At Layer5, we champion developer-defined infrastructure, giving engineers the power to reshape application delivery. We empower operators in reimagining how they manage modern infrastructure: collaboratively.</p>
118
+
<p>At Layer5, we champion developer-defined infrastructure, giving engineers the power to reshape application delivery. We empower operators in reimagining how they manage modern infrastructure: collaboratively.</p>
0 commit comments