Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add codeowners and contributing guide for SWFW content #479

Merged
merged 3 commits into from
Aug 16, 2023
Merged

Add codeowners and contributing guide for SWFW content #479

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4f8e4e
Add Codeowners for SWFW content
jamesholland-uk Aug 16, 2023
51ed5e4
Add contributing guide for SWFW content
jamesholland-uk Aug 16, 2023
c89ec92
Merge branch 'master' into swfw-review-and-auto-generated-content
sserrata Aug 16, 2023
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
4 changes: 4 additions & 0 deletions CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,7 @@ products/terraform/* @PaloAltoNetworks/design-hive
products/ansible/* @PaloAltoNetworks/design-hive
products/panos/* @PaloAltoNetworks/design-hive
products/splunk/* @PaloAltoNetworks/design-hive

# SWFW "Orchestration Hub"
products/terraform/docs/swfw/* @PaloAltoNetworks/pso_prisma_maintainers
products/terraform/sidebars.js @PaloAltoNetworks/pso_prisma_maintainers
21 changes: 21 additions & 0 deletions products/contributing/advanced/auto-generated-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
id: auto-generated-docs
title: Automatically Generated Pages
sidebar_label: Auto-generated Pages
description: Describing that some pages are automatically generated.
---

## Automatically Generated Pages

Some content in pan.dev is generated elsewhere, not in the pan.dev repository directly. This is important to know, because any changes made directly to the files located in the pan.dev repository for this content could be overwritten and lost. Instances of content generated elsewhere are listed below with further details of the original content source.

### Software Firewall (SWFW) Terraform Documentation

The pages linked from the [Orchestration Hub](https://pan.dev/swfw) which describe References Architectures, Examples and Modules for Terraform are automatically copied from their source repository, using a sync system. These pages are viewable on pan.dev at `https://pan.dev/terraform/docs/swfw/{{cloud-id}}}}/vmseries/{{type}}/`, where `cloud-id` is currently `aws`, `azure` or `gcp`, and `type` is currently `reference-architectures`, `examples` or `modules`.

Changes required to these pages should be made in the source repositories. These are currently:
- AWS: https://github.com/PaloAltoNetworks/terraform-aws-vmseries-modules
- Azure: https://github.com/PaloAltoNetworks/terraform-azurerm-vmseries-modules
- GCP: https://github.com/PaloAltoNetworks/terraform-google-vmseries-modules

Any changes made to the README.md files in the `examples` or `modules` directories of the repositories above will be copied to the pan.dev repository in a cloud-specific PR and branch, when a release is performed in the source repository. The changes can then be reviewed and merged using the usual process for pan.dev content.
Loading