Skip to content

Commit 22d2a71

Browse files
authored
Merge pull request #3 from nginxinc/ca
initial files
2 parents 6194800 + b6144a1 commit 22d2a71

File tree

6 files changed

+302
-102
lines changed

6 files changed

+302
-102
lines changed

CHANGELOG.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changelog
22

3-
## 1.0.0 (Month Date, Year)
3+
## 1.0.0 (October 29, 2024)
44

5-
Initial release of the NGINX template repository.
5+
Initial release of the NGINX One Workshop Repo - Chris Akker.

CONTRIBUTING.md

+10-37
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,26 @@
22

33
The following is a set of guidelines for contributing to this project. We really appreciate that you are considering contributing!
44

5-
#### Table of Contents
5+
#### Table Of Contents
66

7-
- [Getting Started](#getting-started)
8-
- [Contributing](#contributing)
9-
- [Code Guidelines](#code-guidelines)
10-
- [Code of Conduct](/CODE_OF_CONDUCT.md)
7+
[Getting Started](#getting-started)
8+
9+
[Contributing](#contributing)
10+
11+
[Code of Conduct](https://github.com/nginxinc/nginx-azure-workshops/blob/main/CODE_OF_CONDUCT.md)
1112

1213
## Getting Started
1314

14-
Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running.
15+
Follow our [Getting Started Guide](https://github.com/nginxinc/nginx-azure-workshops/blob/main/README.md#Getting-Started) to get this project up and running.
1516

1617
<!-- ### Project Structure (OPTIONAL) -->
1718

1819
## Contributing
1920

2021
### Report a Bug
2122

22-
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](/SECURITY.md).**
23-
24-
### Suggest a Feature or Enhancement
25-
26-
To suggest a feature or enhancement, please create an issue on GitHub with the label `enhancement` using the available [feature request template](/.github/feature_request_template.md). Please ensure the feature or enhancement has not already been suggested.
27-
28-
### Open a Pull Request (PR)
29-
30-
- Fork the repo, create a branch, implement your changes, add any relevant tests, and submit a PR when your changes are **tested** and ready for review.
31-
- Fill in the [PR template](/.github/pull_request_template.md).
32-
33-
**Note:** If you'd like to implement a new feature, please consider creating a [feature request issue](/.github/feature_request_template.md) first to start a discussion about the feature.
34-
35-
#### F5 Contributor License Agreement (CLA)
36-
37-
F5 requires all external contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/.github/blob/main/CLA/cla-markdown.md)) before any of their changes can be incorporated into an F5 Open Source repository.
38-
39-
If you have not yet agreed to the F5 CLA terms and submit a PR to this repository, a bot will prompt you to view and agree to the F5 CLA. You will have to agree to the F5 CLA terms through a comment in the PR before any of your changes can be merged. Your agreement signature will be safely stored by F5 and no longer be required in future PRs.
40-
41-
## Code Guidelines
42-
43-
<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->
23+
To report a bug, open an issue on GitHub with the label `bug` using the available bug report issue template. Please ensure the bug has not already been reported. **If the bug is a potential security vulnerability, please report it using our [security policy](https://github.com/nginxinc/nginx-azure-workshops/blob/main/SECURITY.md).**
4424

45-
### Git Guidelines
25+
### Provide Feedback on a Lab Exercise
4626

47-
- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
48-
- If possible and/or relevant, use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format when writing a commit message, so that changelogs can be automatically generated.
49-
- Follow the guidelines of writing a good commit message as described here <https://chris.beams.io/posts/git-commit/> and summarized in the next few points:
50-
- In the subject line, use the present tense ("Add feature" not "Added feature").
51-
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...").
52-
- Limit the subject line to 72 characters or less.
53-
- Reference issues and pull requests liberally after the subject line.
54-
- Add more detailed description in the body of the git message (`git commit -a` to give you more space and time in your text editor to write a good message instead of `git commit -am`).
27+
To send us feedback, please create an issue on GitHub with the label `feedback` using the available feedback template.

README.md

+60-47
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,89 @@
1-
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/template-repository)
2-
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
3-
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/template-repository/blob/main/SUPPORT.md)
4-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
1+
# NGINX ONE Console Workshop 102
52

6-
# NGINX Template Repository
3+
![](labs/media/nginx-one-icon.png)
74

8-
## What is included on this template?
5+
<br/>
96

10-
This template includes all the scaffolding you need to get started on an OSS repository that meets the required NGINX criteria:
7+
This Repo is for learning the **`NGINX ONE Console`**, with Instructor Lead and Self-paced and Hands-on Lab Exercises and Lab Guides that will teach a student using real Nginx instances with NGINX ONE.
118

12-
- [Apache License 2.0](/LICENSE) (required for all NGINX OSS projects).
13-
- [`.gitignore`](/.gitignore) with some minimal sensible defaults.
14-
- [Issue](/.github/ISSUE_TEMPLATE) and [PR](/.github//pull_request_template.md) templates.
15-
- [Contributing](/CONTRIBUTING.md) guidelines.
16-
- [Support](/SUPPORT.md) guidelines for either community and/or commercial support (uncomment the commercial block if necessary).
17-
- [Security](/SECURITY.md) guidelines for reporting major vulnerabilities.
18-
- [Code of Conduct](/CODE_OF_CONDUCT.md).
19-
- [F5 CLA workflow](/.github/workflows/f5-cla.yml). For more details on the action please check the [F5 CLA signature datastore repository](https://github.com/f5/f5-cla-data).
20-
- Open Source Security Foundation (OSSF) Scorecard [(implemented via a GitHub Action)](/.github/workflows/ossf_scorecard.yml)
21-
- [README](/README.md) placeholder. How you structure the README is up to you (although the template provides placeholder sections), but you will need to include:
22-
- A [repostatus](https://www.repostatus.org/) badge.
23-
- An OSSF Scorecard badge. (Optional -- Some projects will by their nature have low scores. In such a case you might want to remove this badge!).
24-
- A community and/or commercial support badge. Include the latter -- and replace the commented out badge/URL placeholder with the relevant support URL -- if this repository contains a commercially supported project. You can find a commented out example below the community badge in this README.
25-
- A contributor covenant/code of conduct badge. (Optional -- If you already have multiple badges and want to reduce clutter, simply including the actual code of conduct is enough!)
26-
- An explicit link back to the [Apache License 2.0](/LICENSE).
27-
- An up to date copyright notice.
28-
- [Changelog](/CHANGELOG.md) placeholder. (Optional -- A changelog is recommended, but it is not required and can diverge in format from the placeholder here included.)
29-
- [Codeowners](/.github/CODEOWNERS) placeholder. (Optional -- Codeowners is a useful feature, but not all repositories require them.)
9+
<br>
3010

31-
**Note:** If you created a public repository before this template became available (or you didn't know about it's existence), please include any missing files found here in your repository. There is no need if you have a private repository, but we still recommend you include all of the above scaffolding should the repository ever become public.
11+
## Audience
3212

33-
## How do I use this template?
13+
This Workshop is meant for Modern Application Developers, DevOps, Platform Ops, and SRE engineers working with NGINX, NGINX Plus, Docker - how they are managed, monitored, and configured using the ONE Console. Using various Nginx instances, you will connect them to NGINX ONE and explore the Console.
3414

35-
**DO NOT FORK** -- this template is meant to be used from the **[`Use this template`](https://github.com/nginxinc/template-repository/generate)** feature.
15+
`The Student taking this Workshop must have the basic skills and knowledge with the following:`
3616

37-
1. Click on **[`Use this template`](https://github.com/nginxinc/template-repository/generate)**.
38-
2. Give a name to your project.
39-
3. Wait until the first run of CI finishes (GitHub Actions will process the template and commit to your new repo).
40-
4. Clone your new project and tweak any of the placeholders if necessary. Pay special attention to the README!
41-
5. Happy coding!
17+
- Nginx Opensource or Plus
18+
- Nginx configurations: files, directives, and variables
19+
- Chrome Browser
20+
- Linux OS / desktop skills
21+
- Optional: Docker container concepts
22+
- Optional: TLS certificates
23+
- Optional: CVE Security concepts
4224

43-
**NOTE**: **WAIT** until the first CI run on GitHub Actions finishes before cloning your new project.
25+
You should be proficient with the following technologies and concepts.
4426

45-
---
27+
- Nginx Webserver and Reverse Proxy
28+
- HTTP 1.1 Protocol, TLS
29+
- Various Desktop tools; Visual Studio, Linux, Terminal, Chrome
4630

47-
<!-- DELETE THE LINES ABOVE THIS AND WRITE YOUR PROJECT README BELOW -- PLACEHOLDER SECTIONS HAVE BEEN INCLUDED FOR YOUR CONVENIENCE -->
31+
<br/>
4832

49-
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)
50-
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/nginx-one-workshops/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/nginx-one-workshops)
51-
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](/SUPPORT.md) <!-- [![Commercial Support](https://badgen.net/badge/support/commercial/cyan?icon=awesome)](<Insert URL>) -->
52-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](/CODE_OF_CONDUCT.md)
33+
## Knowledge and Skills Requirements
5334

54-
# nginx_one_workshops
35+
<br/>
5536

56-
## Requirements
37+
NGINX ONE Console | Hands-On Labs
38+
:-------------------------:|:-------------------------:
39+
![](labs/media/nginx-one-icon.png) | ![](labs/media/developer-seated.svg)
5740

58-
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam elit turpis, varius et arcu elementum, viverra rhoncus sem. Aliquam nec sodales magna, et egestas enim. Mauris lobortis ultrices euismod. Pellentesque in arcu lacus. Mauris cursus laoreet nulla, ac vehicula est. Vestibulum eu mauris quis lorem consectetur aliquam ac nec quam. Vestibulum commodo pharetra mi, at bibendum neque faucibus ut. Mauris et tortor sed sem consectetur eleifend ut non magna. Praesent feugiat placerat nibh, varius viverra orci bibendum sed. Vestibulum dapibus ex ut pulvinar facilisis. Quisque sodales enim et augue tempor mattis. Suspendisse finibus congue felis, ac blandit ligula. Praesent condimentum ultrices odio quis semper. Nunc ultrices, nibh quis mattis pellentesque, elit nulla bibendum felis, quis dapibus erat turpis ac urna.
41+
<br/>
42+
43+
To meet the Prerequisite skills requirement, there are other Workshops from Nginx to help you prepare. The student should have completed the Nginx Basics Workshop 101, prior to taking this workshop. (Or have equivalent knowledge).
44+
45+
- Nginx Basics Workshop - 101 (https://github.com/nginxinc/nginx-basics-workshops/tree/master/labs)
46+
47+
See [Lab0 Readme](/labs/lab0/readme.md) for the Hardware/Software and Skills Prerequisites for taking this Workshop and completing the Lab Exercises.
48+
49+
<br/>
5950

6051
## Getting Started
6152

62-
Duis sit amet sapien vel velit ornare vulputate. Nulla rutrum euismod risus ac efficitur. Curabitur in sagittis elit, a semper leo. Suspendisse malesuada aliquam velit, eu suscipit lorem vehicula at. Proin turpis lacus, semper in placerat in, accumsan non ipsum. Cras euismod, elit eget pretium laoreet, tortor nulla finibus tortor, nec hendrerit elit turpis ut eros. Quisque congue nisi id mauris molestie, eu condimentum dolor rutrum. Nullam eleifend elit ac lobortis tristique. Pellentesque nec tellus non mauris aliquet commodo a eu elit. Ut at feugiat metus, at tristique mauris. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae;
53+
Review the Github Repo content for the Nginx Basics Workshop 101. If you have taken this Workshop, and understand the content, you can successfully complete the Lab exercises in this Nginx ONE Workshop. It is HIGHLY recommended that you complete the 101 Workshop prior.
54+
55+
It will take approximately 1 hour to complete the Nginx ONE Workshop.
56+
57+
<br/>
6358

6459
## How to Use
6560

66-
Maecenas at vehicula justo. Suspendisse posuere elementum elit vel posuere. Etiam quis pulvinar massa. Integer tempor semper risus, vitae maximus eros ullamcorper vitae. In egestas, ex vitae gravida sodales, ipsum dolor varius est, et cursus lorem dui a mi. Morbi faucibus ut nisi id faucibus. Sed quis ullamcorper ex. In et dolor id nunc interdum suscipit.
61+
The content and lab exercises are presented in a sequence as you build and add additional Nginx instances and functionality as you progress. It is essential that the Lab Exercises are completed in the order provided. This content provided is for example only, is not for production workloads. The user of this information assumes all risks.
62+
63+
- Click [LabGuide](labs/readme.md) to begin the Lab Exercises.
64+
- Click [Lab0 Readme](labs/lab0/readme.md) to review the Lab0 Prerequisites - "Know before you Go".
65+
66+
<br/>
6767

6868
## Contributing
6969

70-
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
70+
Please see the [contributing guide](https://github.com/nginxinc/nginx-one-workshops/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
71+
72+
<br/>
73+
74+
### Authors
75+
76+
- Chris Akker - Solutions Architect - Community and Alliances @ F5, Inc.
77+
- Shouvik Dutta - Solutions Architect - Community and Alliances @ F5, Inc.
78+
- Adam Currier - Solutions Architect - Community and Alliances @ F5, Inc.
79+
80+
-------------
81+
82+
<br/>
7183

7284
## License
7385

74-
[Apache License, Version 2.0](/LICENSE)
86+
[Apache License, Version 2.0](https://github.com/nginxinc/nginx-one-workshops/blob/main/LICENSE)
87+
7588

7689
&copy; [F5, Inc.](https://www.f5.com/) 2024

SUPPORT.md

+30-16
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,56 @@
44

55
We use GitHub for tracking bugs and feature requests related to this project.
66

7-
Don't know how something in this project works? Curious if this project can achieve your desired functionality? Please open an issue on GitHub with the label `question`. Alternatively, start a GitHub discussion!
7+
Don't know how something in the nginx_azure_workshops works? Curious if the nginx_azure_workshops can achieve your desired functionality? Please open an issue on GitHub with the label `question`.
8+
9+
<br/>
810

911
## NGINX Specific Questions and/or Issues
1012

1113
This isn't the right place to get support for NGINX specific questions, but the following resources are available below. Thanks for your understanding!
1214

13-
<!--
14-
To be replaced with Discourse
15+
<br/>
1516

16-
### Community Slack
17+
## F5 Support
1718

18-
We have a community [Slack](https://nginxcommunity.slack.com/)!
19+
If you’re an F5 customer with NGINX Plus and an active support contract, please contact [F5 Technical Support](https://www.f5.com/services/support).
1920

20-
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up. (Let us know if the link does not seem to be working at <[email protected]>!)
21+
<br/>
2122

22-
Once you join, check out the `#beginner-questions` and `nginx-users` channels :)
23-
-->
23+
## Documentation
2424

25-
### Documentation
25+
For a comprehensive list of all NGINX directives, check out <http://nginx.org/en/docs/dirindex.html>.
2626

27-
For a comprehensive list of all NGINX directives, check out <https://nginx.org>.
27+
For a comprehensive list of all NGINX variables, check out <http://nginx.org/en/docs/varindex.html>.
2828

29-
For a comprehensive list of administration and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
29+
For a comprehensive list of admin and deployment guides for NGINX Plus, check out <https://docs.nginx.com/nginx/admin-guide/>.
30+
31+
For a comprehensive list of admin and deployment guides for all NGINX products, check out <https://docs.nginx.com>.
32+
33+
</br>
3034

3135
### Mailing List
3236

3337
Want to get in touch with the NGINX development team directly? Try using the relevant mailing list found at <https://mailman.nginx.org/mailman3/lists/>!
3438

39+
<br/>
40+
3541
## Contributing
3642

37-
Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
43+
Please see the [contributing guide](https://github.com/nginxinc/nginx-azure-workshops/blob/main/CONTRIBUTING.md) for guidelines on how to best contribute to this project.
3844

39-
<!-- ## Commercial Support
45+
<br/>
4046

41-
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.f5.com/products/get-f5/) or check your contract details for more information! -->
47+
## Commercial Support
4248

43-
## Community Support
49+
Commercial support for this project may be available. Please get in touch with [NGINX sales](https://www.nginx.com/contact-sales/) or check your contract details for more info!
4450

45-
This project does **not** offer commercial support. Community support is offered on a best effort basis through either GitHub issues/PRs/discussions or through any of our active communities.
51+
<br/>
52+
53+
### Community Slack
54+
55+
We have a community [Slack](https://nginxcommunity.slack.com/)!
56+
57+
If you are not a member, click [here](https://community.nginx.org/joinslack) to sign up (and let us know if the link does not seem to be working!)
58+
59+
Once you join, check out the `#beginner-questions` and `nginx-users` channels :)

0 commit comments

Comments
 (0)