Skip to content

Commit 7b77924

Browse files
authored
Merge branch 'master' into test-postgres
Signed-off-by: Lee Calcote <leecalcote@gmail.com>
2 parents e4340f7 + b08d4c1 commit 7b77924

268 files changed

Lines changed: 7768 additions & 196 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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ assignees: ''
2828

2929
---
3030
#### Contributor Guide and Resources
31-
- 📚 [Instructions for contributing to academy-example](https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md)
32-
- academy-example documentation [site](https://docs.layer5.io/cloud/academy/) and [source](https://github.com/layer5io/academy-example/)
31+
- 📚 [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/)
3333
- 🎨 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)
3434
- 🙋🏾🙋🏼 Questions: [Layer5 Discussion Forum](https://discuss.layer5.io) and [Layer5 Community Slack](http://slack.layer5.io)

.github/ISSUE_TEMPLATE/ci.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ assignees: ''
1919

2020
---
2121
#### Contributor Guide and Resources
22-
- 📚 [Instructions for contributing to academy-example](https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md)
23-
- academy-example documentation [site](https://docs.layer5.io/cloud/academy/) and [source](https://github.com/layer5io/academy-example/)
22+
- 📚 [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/)
2424
- 🎨 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)

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🙋🏾🙋🏼‍Question
4+
url: https://discuss.layer5.io
5+
about: Submit your question on the discussion forum.

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ assignees: ''
1313

1414
---
1515
#### Contributor Guide and Resources
16-
- 📚 [Instructions for contributing to academy-example](https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md)
17-
- academy-example documentation [site](https://docs.layer5.io/cloud/academy/) and [source](https://github.com/layer5io/academy-example/)
16+
- 📚 [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/)
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: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: 💡 Feature Request
3-
about: Suggest an enhancement to Meshery.
3+
about: Suggest an enhancement to Layer5 Academy.
44
title: ''
55
labels: 'kind/enhancement'
66
assignees: ''
@@ -21,5 +21,8 @@ assignees: ''
2121
<!-- [Optional] Any visual diagrams of the desired user interface. -->
2222

2323
---
24-
**[Contributor Guide](https://github.com/layer5io/academy-example/blob/master/CONTRIBUTING.md)**
24+
#### Contributor Guide and Resources
25+
- 📚 [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/)
2527
- 🎨 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)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/workflows/static.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ concurrency:
2323
jobs:
2424
# Single deploy job since we're just deploying
2525
deploy:
26+
if: github.event.pull_request.head.repo.full_name != github.repository
27+
2628
environment:
2729
name: pr-preview-${{ github.event.pull_request.number || github.run_id }}
2830
url: ${{ steps.deployment.outputs.page_url }}
@@ -47,8 +49,39 @@ jobs:
4749
# Upload just the public folder
4850
path: 'public'
4951
- name: Deploy to GitHub Pages
52+
if: github.event.pull_request.head.repo.full_name == github.repository
5053
id: deployment
5154
uses: actions/deploy-pages@v4
55+
56+
57+
58+
59+
60+
61+
62+
- name: Commit changes
63+
if: github.event.pull_request.head.repo.full_name != github.repository
64+
uses: stefanzweifel/git-auto-commit-action@v5
65+
with:
66+
file_pattern: mesheryctl/helpers server/helpers/ **.go docs/
67+
commit_user_name: l5io
68+
commit_user_email: ci@meshery.io
69+
commit_author: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
70+
commit_options: "--signoff"
71+
commit_message: "Deployment preview for PR ${{ github.event.pull_request.number }}"
72+
73+
# - name: Set up Git user
74+
# if: github.event.pull_request.head.repo.full_name != github.repository
75+
# run: |
76+
# git config user.name "l5io"
77+
# git config user.email "l5io@users.noreply.github.com"
78+
# - name: Push branch to master repo
79+
# if: github.event.pull_request.head.repo.full_name != github.repository
80+
# run: |
81+
# git remote add main-origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
82+
# git push main-origin HEAD:refs/heads/pr-preview/${{ github.event.pull_request.number }} --force
83+
84+
5285
- name: Comment Preview URL on PR
5386
if: github.event_name == 'pull_request'
5487
uses: marocchino/sticky-pull-request-comment@v2
@@ -61,3 +94,24 @@ jobs:
6194
> 📖 General Preview: ${{ steps.deployment.outputs.page_url }}
6295
6396
This preview will be updated automatically when you push new commits to this PR.
97+
98+
99+
100+
101+
102+
103+
104+
105+
106+
# mirror-fork-pr:
107+
# if: github.event.pull_request.head.repo.full_name != github.repository
108+
# environment:
109+
# name: pr-preview-${{ github.event.pull_request.number || github.run_id }}
110+
# # url: ${{ steps.deployment.outputs.page_url }}
111+
# runs-on: ubuntu-latest
112+
# steps:
113+
# - name: Checkout PR branch
114+
# uses: actions/checkout@v4
115+
# with:
116+
# ref: ${{ github.event.pull_request.head.ref }}
117+
# repository: ${{ github.event.pull_request.head.repo.full_name }}

CONTRIBUTING.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# <a name="contributing">Contributing Overview</a>
22
Please do! Thanks for your help improving the project! :balloon:
33

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).
55

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).
77

88
**Sections**
99
- <a name="contributing">General Contribution Flow</a>
@@ -13,20 +13,17 @@ Relevant coding style guidelines are the Go Code Review Comments and the Formatt
1313

1414
## Important Information
1515

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.
1717

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.
2118

2219
### Detailed Guide
2320
For a complete, step-by-step guide on how to create, structure, and publish a new learning path, please refer to our official documentation:
2421

25-
➡️ [Creating Your First Learning Path](https://docs.layer5.io/cloud/academy/creating-your-learning-path/)
22+
➡️ [Academy](https://docs.layer5.io/cloud/academy/)
2623

2724
# <a name="contributing">General Contribution Flow</a>
2825

29-
In order to contribute to Meshery, please follow the fork-and-pull request workflow described [here](./CONTRIBUTING-gitflow.md).
26+
In order to contribute to Layer5 Academy, please follow the fork-and-pull request workflow described [here](./CONTRIBUTING-gitflow.md).
3027

3128
## <a name="commit-signing">Signing-off on Commits (Developer Certificate of Origin)</a>
3229

@@ -47,7 +44,7 @@ In most cases, you can add this signoff to your commit automatically with the
4744
`-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email
4845
address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit:
4946
```
50-
$ commit -s -m my commit message w/signoff
47+
$ commit -s -m "my commit message w/signoff"
5148
```
5249

5350
To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```:
@@ -63,16 +60,16 @@ Or you may configure your IDE, for example, Visual Studio Code to automatically
6360

6461
<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>
6562

66-
## <a name="contributing-docs">Documentation Contribution Flow</a>
67-
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:
63+
## <a name="contributing-docs">Academy Content Contribution Flow</a>
64+
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:
6865

6966
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`
7269
1. Create and checkout a new branch to make changes within
7370
`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`
7673
1. Run site locally to preview changes.
7774
`make site`
7875
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
8178

8279

8380
#### 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.
8582

86-
To test code changes on your local machine, run the following command:
83+
To test your local Academy setup, run the following commands:
8784
```
88-
make run-tests
85+
# Install dependencies
86+
make setup
87+
88+
# Start local development server
89+
make site
8990
```
9091

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:
9394
```sh
94-
make docker
95+
make build
9596
```
9697

97-
### UI Lint Rules
98+
### Content Guidelines
9899

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.
100101

101102
# <a name="maintaining"> Reviews</a>
102103
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
114115
<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>
115116

116117
**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

Comments
 (0)