Skip to content

Commit

Permalink
Add codeowners and contributing guide for SWFW content (#479)
Browse files Browse the repository at this point in the history
* Add Codeowners for SWFW content
* Add contributing guide for SWFW content
---------
Co-authored-by: Steven Serrata <[email protected]>
  • Loading branch information
jamesholland-uk authored Aug 16, 2023
1 parent d3710e0 commit 4b30757
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
4 changes: 4 additions & 0 deletions CODEOWNERS
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
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.

0 comments on commit 4b30757

Please sign in to comment.