Skip to content

Commit 013bec6

Browse files
authored
Merge branch 'master' into master
2 parents 74e54ac + cdb038c commit 013bec6

372 files changed

Lines changed: 3735 additions & 1302 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,10 @@ assignees: ''
2727
-->
2828

2929
---
30+
3031
#### Contributor Guide and Resources
32+
3133
- 📚 [Instructions for contributing to layer5-academy](https://github.com/layer5io/layer5-academy/blob/master/CONTRIBUTING.md)
32-
- 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/)
34+
- 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/)
3335
- 🎨 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)
3436
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/ci.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,10 @@ assignees: ''
1818
<!-- Stipulations of functional behavior or non-functional items that must be in-place in order for the issue to be closed. -->
1919

2020
---
21+
2122
#### Contributor Guide and Resources
23+
2224
- 📚 [Instructions for contributing to layer5-academy](https://github.com/layer5io/layer5-academy/blob/master/CONTRIBUTING.md)
23-
- 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+
- 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/)
2426
- 🎨 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)
27+
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ assignees: ''
77
---
88
#### Current State
99

10-
1110
#### Desired State
1211

13-
1412
---
13+
1514
#### Contributor Guide and Resources
15+
1616
- 📚 [Instructions for contributing to layer5-academy](https://github.com/layer5io/layer5-academy/blob/master/CONTRIBUTING.md)
17-
- 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/)
17+
- 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/)
1818
- 🎨 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)
1919
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ assignees: ''
2121
<!-- [Optional] Any visual diagrams of the desired user interface. -->
2222

2323
---
24+
2425
#### Contributor Guide and Resources
26+
2527
- 📚 [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/)
28+
- 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/)
2729
- 🎨 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)
30+
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,9 @@
22

33
This PR fixes #
44

5-
6-
7-
85
**[Signed commits](../blob/master/CONTRIBUTING.md#signing-off-on-commits-developer-certificate-of-origin)**
6+
97
- [ ] Yes, I signed my commits.
10-
118

129
<!--
1310
Thank you for contributing to Meshery!

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
The Layer5 community follows the code of conduct outlined in the [Community Handbook]([https://layer5.io](https://layer5.io/community/handbook/code-of-conduct).
44

5-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting community@layer5.io.
5+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting <community@layer5.io>.

CONTRIBUTING-gitflow.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,53 @@
11
# Working by Forking
2+
23
Just head over to the GitHub page and click the "Fork" button. It's just that simple. Once you've done that, you can use your favorite git client to clone your repo or just head straight to the command line:
34

45
## Clone your fork to your local machine
5-
```
6+
7+
```shell
68
git clone git@github.com:USERNAME/FORKED-PROJECT.git
79
```
10+
811
Keeping Your Fork Up to Date
912
While this isn't an absolutely necessary step, if you plan on doing anything more than just a tiny quick fix, you'll want to make sure you keep your fork up to date by tracking the original "upstream" repo that you forked. To do this, you'll need to add a remote:
1013

1114
## Add 'upstream' repo to list of remotes
12-
```
15+
16+
```shell
1317
git remote add upstream https://github.com/layer5io/meshery.git
14-
```
18+
```
19+
1520
("meshery" is used as the example repo. Be sure to reference the _actual_ repo you're contributing to e.g. "meshery-linkerd").
1621

1722
## Verify the new remote named 'upstream'
18-
```
23+
24+
```shell
1925
git remote -v
2026
```
27+
2128
Whenever you want to update your fork with the latest upstream changes, you'll need to first fetch the upstream repo's branches and latest commits to bring them into your repository:
2229

2330
## Fetch from upstream remote
24-
```
31+
32+
```shell
2533
git fetch upstream
2634
```
2735

2836
## View all branches, including those from upstream
29-
```
37+
38+
```shell
3039
git branch -va
3140
```
41+
3242
Now, checkout your own master branch and merge the upstream repo's master branch:
3343

3444
## Checkout your master branch and merge upstream
35-
```
45+
46+
```shell
3647
git checkout master
3748
git merge upstream/master
3849
```
50+
3951
If there are no unique commits on the local master branch, git will simply perform a fast-forward. However, if you have been making changes on master (in the vast majority of cases you probably shouldn't be - see the next section, you may have to deal with conflicts. When doing so, be careful to respect the changes made upstream.
4052

4153
Now, your local master branch is up-to-date with everything modified upstream.
@@ -46,50 +58,61 @@ Whenever you begin work on a new feature or bugfix, it's important that you crea
4658
To create a new branch and start working on it, peform the following flow.
4759

4860
## Checkout the master branch - you want your new branch to come from master
49-
```
61+
62+
```shell
5063
git checkout master
5164
```
5265

5366
## Create a new branch (give your branch its own simple informative name)
67+
5468
For enhancements use `feature/your_username/issue#` or `feature/your_username/name_of_feature`
5569

5670
For bugs use `bug/your_username/issue#` or `bug/your_username/name_of_bug`
5771

58-
```
72+
```shell
5973
git branch feature/jdoe/567
6074
```
6175

6276
## Switch to your new branch
63-
```
77+
78+
```shell
6479
git checkout feature/jdoe/567
6580
```
81+
6682
Now, go to town hacking away and making whatever changes you want to.
6783

6884
## Submitting your changes (a Pull Request)
85+
6986
Prior to submitting your pull request, you might want to do a few things to clean up your branch and make it as simple as possible for the original repo's maintainer to test, accept, and merge your work.
7087

7188
In the time that you've been working on your changes, if any commits have been made to the upstream master branch, you will need to rebase your development branch so that merging it will be a simple fast-forward that won't require any conflict resolution work.
7289

7390
## Fetch upstream master and merge with your repo's master branch
74-
```
91+
92+
```shell
7593
git fetch upstream
7694
git checkout master
7795
git merge upstream/master
7896
```
7997

8098
## If there were any new commits, rebase your development branch
81-
```
99+
100+
```shell
82101
git checkout feature/jdoe/567
83102
git rebase master
84103
```
104+
85105
Now, it may be desirable to squash some of your smaller commits down into a small number of larger more cohesive commits. You can do this with an interactive rebase:
86106

87107
## Rebase all commits on your development branch
88-
```
108+
109+
```shell
89110
git checkout
90111
git rebase -i master
91112
```
113+
92114
This will open up a text editor where you can specify which commits to squash.
93115

94116
## Submitting
117+
95118
Once you've committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes on your development branch and update.

CONTRIBUTING.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
# <a name="contributing">Contributing Overview</a>
2+
23
Please do! Thanks for your help improving the project! :balloon:
34

45
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).
56

67
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).
78

89
**Sections**
10+
911
- <a name="contributing">General Contribution Flow</a>
1012
- <a href="#commit-signing">Developer Certificate of Origin</a>
1113

@@ -15,8 +17,8 @@ Relevant coding style guidelines are the Go Code Review Comments and the Formatt
1517

1618
This repository serves as the **official content repository** for Layer5's Academy learning platform, hosting all official learning paths, challenges, and certifications.
1719

18-
1920
### Detailed Guide
21+
2022
For a complete, step-by-step guide on how to create, structure, and publish a new learning path, please refer to our official documentation:
2123

2224
➡️ [Academy](https://docs.layer5.io/cloud/academy/)
@@ -43,24 +45,28 @@ Signed-off-by: Jane Smith <jane.smith@example.com>
4345
In most cases, you can add this signoff to your commit automatically with the
4446
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
4547
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
48+
4649
```
47-
$ commit -s -m "my commit message w/signoff"
50+
commit -s -m "my commit message w/signoff"
4851
```
4952

5053
To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```:
5154

5255
*~/.gitconfig*
56+
5357
```
5458
[alias]
5559
amend = commit -s --amend
5660
cm = commit -s -m
5761
commit = commit -s
5862
```
63+
5964
Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you:
6065

6166
<a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a>
6267

6368
## <a name="contributing-docs">Academy Content Contribution Flow</a>
69+
6470
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:
6571

6672
1. Create a fork, if you have not already, by following the steps described [here](./CONTRIBUTING-gitflow.md)
@@ -76,11 +82,12 @@ Please contribute! Layer5 Academy uses Hugo and GitHub Pages to host the learnin
7682
`git push origin <my-changes>`
7783
1. Open a pull request (in your web browser) against the repo.
7884

79-
8085
#### Tests
86+
8187
Users can now test their local development setup using the provided Makefile commands.
8288

8389
To test your local Academy setup, run the following commands:
90+
8491
```
8592
# Install dependencies
8693
make setup
@@ -90,7 +97,9 @@ make site
9097
```
9198

9299
#### Building the Site
100+
93101
To build the Academy site for production, ensure you have `Hugo` and `Go` installed. Now, run the following command to build the site:
102+
94103
```sh
95104
make build
96105
```
@@ -100,10 +109,12 @@ make build
100109
Layer5 Academy follows specific content and formatting guidelines for consistency across all learning materials.
101110

102111
# <a name="maintaining"> Reviews</a>
112+
103113
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).
104114

105115
# New to Git?
106-
Resources: https://lab.github.com and https://try.github.com/
116+
117+
Resources: <https://lab.github.com> and <https://try.github.com/>
107118

108119
### License
109120

@@ -115,4 +126,4 @@ This repository and site are available as open source under the terms of the [Ap
115126
<p>The <a href="https://layer5.io/community">Layer5 community</a> represents the largest collection of service mesh projects and their maintainers in the world.</p>
116127

117128
**Open Source First**
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>
129+
<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>

Makefile

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
#include .github/build/Makefile.show-help.mk
15+
include .github/build/Makefile.show-help.mk
1616

17-
## Install academy-example dependencies on your local machine.
18-
## See https://gohugo.io/categories/installation
17+
## Install dependencies on your local machine.
1918
setup:
2019
npm install
2120

@@ -36,16 +35,25 @@ clean:
3635
hugo --cleanDestinationDir
3736
make site
3837

38+
## Fix Markdown linting issues
39+
lint-fix:
40+
@echo "Checking for markdownlint-cli2..."
41+
@command -v markdownlint-cli2 > /dev/null || { \
42+
echo "markdownlint-cli2 not found. Attempting to install globally..."; \
43+
command -v npm > /dev/null || { echo "npm is not installed. Please install Node.js/npm and re-run 'make lint-fix'."; exit 1; }; \
44+
npm install -g markdownlint-cli2; \
45+
}
46+
@echo "Running markdownlint-cli2 --fix..."
47+
@markdownlint-cli2 --fix "**/*.md" "#node_modules" "#public" "#resources"
3948

4049
check-go:
4150
@echo "Checking if Go is installed..."
4251
@command -v go > /dev/null || (echo "Go is not installed. Please install it before proceeding."; exit 1)
4352
@echo "Go is installed."
4453

45-
4654
## Update the academy-theme package to latest version
4755
theme-update:
4856
echo "Updating to latest academy-theme..." && \
4957
hugo mod get github.com/layer5io/academy-theme
5058

51-
.PHONY: setup build site clean site-fast check-go academy-update
59+
.PHONY: setup build site clean check-go theme-update

0 commit comments

Comments
 (0)