Skip to content

style: Reorg repo structure and add CODEOWNERS #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
#####################
# Main global owner #
#####################
###############
# Demo owners #
###############

*
nginx/advanced-healthchecks @fabriziofiorucci
nginx/api-gateway @alessfg
nginx/api-steering @fabriziofiorucci
nginx/docker-image-builder @fabriziofiorucci
nginx/multicloud-gateway @fabriziofiorucci
nginx/soap-to-rest @fabriziofiorucci
nginx-gateway-fabric/traffic-splitting @sjberman
nginx-ingress-controller/ingress-deployment @DylenTurnbull
nginx-instance-manager/docker-deployment @fabriziofiorucci
nginx-workshops @apcurrier @sdutta9
1 change: 1 addition & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Before creating a PR, run through this checklist and mark each as complete:
- [ ] I have signed the [F5 Contributor License Agreement (CLA)](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md).
- [ ] If applicable, I have added tests that prove my fix is effective or that my feature works.
- [ ] If applicable, I have checked that any relevant tests pass after adding my changes.
- [ ] If this is a new demo, I have added the demo info to both the [`CODEOWNERS`](/.github/CODEOWNERS) and [`README.md`](/README.md).
- [ ] I have updated any relevant documentation ([`README.md`](/README.md) and/or [`CHANGELOG.md`](/CHANGELOG.md)).
15 changes: 1 addition & 14 deletions .github/workflows/ossf_scorecard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,27 +8,19 @@ on:
schedule:
- cron: "0 0 * * 1"
push:
branches: [main, master]
branches: [main]
workflow_dispatch:
# Declare default permissions as read only.
permissions: read-all
jobs:
analysis:
name: Scorecard analysis
runs-on: ubuntu-24.04
# Delete the conditional below if you are using the OSSF Scorecard on a private repository.
if: ${{ github.event.repository.private == false }}
permissions:
# Needed if using Code Scanning alerts.
security-events: write
# Needed for GitHub OIDC token if publish_results is true.
id-token: write
# Uncomment the permissions below if you are using the OSSF Scorecard on a private repository.
# contents: read
# actions: read
# issues: read # To allow GraphQL ListCommits to work
# pull-requests: read # To allow GraphQL ListCommits to work
# checks: read # To detect SAST tools
steps:
- name: Check out the codebase
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
Expand All @@ -40,12 +32,7 @@ jobs:
with:
results_file: results.sarif
results_format: sarif
# (Optional) fine-grained personal access token. Uncomment the `repo_token` line below if you want to enable the Branch-Protection or Webhooks check on a *private* repository.
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-fine-grained-pat-optional.
# repo_token: ${{ secrets.SCORECARD_TOKEN }}

# Publish the results for public repositories to enable scorecard badges. For more details, see https://github.com/ossf/scorecard-action#publishing-results.
# For private repositories, `publish_results` will automatically be set to `false`, regardless of the value entered here.
publish_results: true

# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF format to the repository Actions tab.
Expand Down
3 changes: 0 additions & 3 deletions CHANGELOG.md

This file was deleted.

8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ The following is a set of guidelines for contributing to this project. We really

Follow the instructions on the README's [Getting Started](/README.md#Getting-Started) section to get this project up and running.

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

This repo contains multiple demos. Each demo contained in this repo has to be fully functional and have an active owner. The active owner can be found in the [`CODEOWNERS`](/.github/CODEOWNERS) file. At this moment, there is no automated way to verify if demos are functional, but in the future there will be an automated pipeline. If a demo is reported to be non-functional, the owner will be notified. If the demo is not fixed/updated within a reasonable timeline, the demo will be shelved into a different non-functional folder. If after a further reasonable amount of time the demo has still not been fixed/updated, the demo will be removed from this repo.

## Contributing

Expand All @@ -34,14 +36,12 @@ To suggest a feature or enhancement, please create an issue on GitHub with the l

#### F5 Contributor License Agreement (CLA)

F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/.github/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).
F5 requires all contributors to agree to the terms of the F5 CLA (available [here](https://github.com/f5/f5-cla/blob/main/docs/f5_cla.md)) before any of their changes can be incorporated into an F5 Open Source repository (even contributions to the F5 CLA itself!).

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.

## Code Guidelines

<!-- ### Go/Python/Bash/etc... Guidelines (OPTIONAL) -->

### Git Guidelines

- Keep a clean, concise and meaningful git commit history on your branch (within reason), rebasing locally and squashing before submitting a PR.
Expand Down
47 changes: 35 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,41 @@ Each demo might have unique deployment requirements. Please refer to each indivi

## Available Demos

|Title|Description|
|-----|-----------|
|NGINX Advanced Healthcheck|Advanced active healthchecks for NGINX Plus|
|NGINX API gateway|Configure NGINX as an API gateway|
|NGINX API Steering|NGINX as an API gateway using an external data source for authentication, authorization and steering|
|NGINX Docker Image Builder|Tool to build several docker images for NGINX Plus, NGINX App Protect, NGINX Agent|
|NGINX Gateway Fabric|Simple overview of configuring NGINX Gateway Fabric to route traffic within Kubernetes|
|NGINX Ingress Controller|Simple overview of deploying and configuring NGINX Ingress Controller|
|NGINX Multicloud Gateway|NGINX setup for URI-based kubernetes traffic routing|
|NGINX NIM Docker|Tool to build docker images for NGINX Instance Manager|
|NGINX One|Simple overview of NGINX One and its capabilities|
|NGINX SOAP REST|Example NGINX configuration to translate between SOAP and REST|
### NGINX

|Title|Description|Owner|
|-----|-----------|-----|
|[NGINX advanced healthchecks](nginx/advanced-healthchecks/)|Advanced active healthchecks for NGINX Plus|@fabriziofiorucci|
|[NGINX API gateway](nginx/api-gateway/)|Configure NGINX as an API gateway|@alessfg|
|[NGINX API steering](nginx/api-steering/)|NGINX as an API gateway using an external data source for authentication, authorization and steering|@fabriziofiorucci|
|[NGINX Docker image builder](nginx/docker-image-builder/)|Tool to build several Docker images for NGINX Plus, NGINX App Protect, NGINX Agent|@fabriziofiorucci|
|[NGINX multicloud gateway](nginx/multicloud-gateway/)|NGINX setup for URI-based kubernetes traffic routing|@fabriziofiorucci|
|[NGINX SOAP REST](nginx/soap-to-rest/)|Example NGINX configuration to translate between SOAP and REST|@fabriziofiorucci|

### NGINX Gateway Fabric (NGF)

|Title|Description|Owner|
|-----|-----------|-----|
|[NGINX Gateway Fabric traffic splitting](nginx-gateway-fabric/traffic-splitting/)|Simple overview of configuring NGINX Gateway Fabric to route traffic within Kubernetes|@sjberman|

### NGINX Ingress Controller (NIC)

|Title|Description|Owner|
|-----|-----------|-----|
|[NGINX Ingress Controller deployment](nginx-ingress-controller/ingress-deployment/)|Simple overview of deploying and configuring NGINX Ingress Controller|@DylenTurnbull|

### NGINX Instance Manager (NIM)

|Title|Description|Owner|
|-----|-----------|-----|
|[NGINX Instance Manager Docker deployment](nginx-instance-manager/docker-deployment/)|Tool to build docker images for NGINX Instance Manager|@fabriziofiorucci|

### NGINX Workshops

|Title|Description|Owner|
|-----|-----------|-----|
|[NGINX basics](nginx-workshops/nginx-basics/)|A 101 level introduction to NGINX|@apcurrier|
|[NGINX One](nginx-workshops/nginx-one/)|Learn everything you need to get started with NGINX One and its capabilities|@sdutta9|

## Contributing

Expand Down
4 changes: 0 additions & 4 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ Want to get in touch with the NGINX development team directly? Try using the rel

Please see the [contributing guide](/CONTRIBUTING.md) for guidelines on how to best contribute to this project.

<!-- ## Commercial Support

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! -->

## Community Support

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.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.