|
1 | 1 |  |
2 | 2 |
|
3 | | -# Prisma Cloud Compute Community Docs |
| 3 | +# Deprecation notice |
4 | 4 |
|
5 | | -Welcome to the docs project for [Prisma Cloud Compute](https://www.paloaltonetworks.com/prisma/cloud/compute-security). |
6 | | -Docs are a core part of the product and we build them just like we build the software in it - using modern collaboration platforms like GitHub and publishing them through a CI/CD pipeline with Jenkins. |
7 | | -As of May 2020, we've open sourced the docs so that anyone can contribute directly to them and see their work quickly go live for the whole community's benefit. |
8 | | -This repo is where that happens. |
| 5 | +This repo is in the process of being deprecated. |
9 | 6 |
|
10 | | -# Who? |
| 7 | +Starting on August 30, 2021, all Prisma Cloud Compute docs will be hosted here: |
11 | 8 |
|
12 | | -Anyone can contribute the docs with simple pull requests. |
13 | | -All PRs are reviewed by product team members for accuracy and consistency and we'll collaborate with you on any questions or suggestions. |
14 | | -Because everything happens on GitHub, all your contributions are clearly visible and recognized. |
| 9 | +https://github.com/PaloAltoNetworks/prisma-cloud-docs |
15 | 10 |
|
16 | | -# What? |
| 11 | +Please submit pull requests to the new repo only. |
17 | 12 |
|
18 | | -PRs of any size or form are welcome, from simple clarifications of wording to entirely new how-to articles. |
19 | | -All content is in the open source [AsciiDoctor](https://asciidoctor.org/) format, which can be edited right in the GitHub browser IDE or any other text editor of your choice. |
20 | | - |
21 | | -The Prisma Cloud Compute product team will continue to author docs for all new features and changes in each release. |
22 | | - |
23 | | -# When? |
24 | | - |
25 | | -We review PRs daily. |
26 | | -If there are no questions or further discussion, you'll see your changes live the next business day. |
27 | | -A Jenkins job runs nightly to publish the latest content. |
28 | | - |
29 | | -# Where? |
30 | | - |
31 | | -All Prisma Cloud Compute documentation is included in this repo. |
32 | | -Because the entire docs source is just text files in GitHub, it's easy to work with the way you want. |
33 | | -Docs are published in two places: |
34 | | - |
35 | | -* Official docs: https://docs.paloaltonetworks.com/prisma/prisma-cloud.html |
36 | | -* Daily doc builds: https://docs.prismacloudcompute.com/docs/ |
37 | | - |
38 | | -# Why? |
39 | | - |
40 | | -The best docs are written by people that really use and understand the technology. While we on the product team are still intimately involved in creating and maintaining the docs, we know that everyone will benefit from the experiences and knowledge of the overall community. |
41 | | - |
42 | | -# How? |
43 | | - |
44 | | -1. Fork the repo. |
45 | | -2. Make your changes directly in the GitHub UI, or with your editor of choice and the git command line tool. |
46 | | -3. Submit your changes back to the repo as a pull request. |
47 | | - |
48 | | -# Structure |
49 | | - |
50 | | -Each guide has its own dedicated directory. |
51 | | -For example, the Administrator's Guide can be found in the top level `admin_guide/` dir. |
52 | | - |
53 | | -Each guide has a topic map, written in YAML format. |
54 | | -Topic maps reference all the individual source files that make up a document. |
55 | | -They're also used to generate a document's navigation menu. |
56 | | - |
57 | | -Source files are written in AsciiDoctor and have the `.adoc` extension. |
58 | | -Each source file holds one "article", which is rendered as a single page on the doc site. |
59 | | - |
60 | | -Source for the Administrator's Guide uses conditional content to target either Compute Edition (self-hosted) or Enterprise Edition (SaaS). |
61 | | -Content that only applies to one or the other is fenced with AsciiDoctor's `ifdef` and `endif` directives. |
62 | | - |
63 | | -For Compute Edition-specific content: |
64 | | - |
65 | | -``` |
66 | | -ifdef::compute_edition[] |
67 | | -Download and run Console in your own environment. |
68 | | -endif::compute_edition[] |
69 | | -``` |
70 | | - |
71 | | -For Enterprise Edition-specific content: |
72 | | - |
73 | | -``` |
74 | | -ifdef::prisma_cloud[] |
75 | | -Palo Alto Networks runs Console for you. |
76 | | -endif::prisma_cloud[] |
77 | | -``` |
78 | | - |
79 | | -# Building the site locally |
80 | | - |
81 | | -The site uses a Red Hat project called [AsciiBinder](https://github.com/redhataccess/ascii_binder) in conjunction with our own package `ascii_binder_pan-0.0.00.1.gem`, located at the root of this repo. |
82 | | - |
83 | | -As you create and edit content, we recommend making a local build to check the rendering. |
84 | | -To do so, complete the following steps. |
85 | | -Instructions are geared for macOS. |
86 | | - |
87 | | -1. Ensure that Ruby is installed. |
88 | | - |
89 | | - ```bash |
90 | | - ruby -v |
91 | | - ``` |
92 | | - |
93 | | -1. If you haven't already installed pyenv and pyenv-virtualenv, go ahead and do so now. |
94 | | -
|
95 | | - ```bash |
96 | | - brew install pyenv |
97 | | - brew install pyenv-virtualenv |
98 | | - ``` |
99 | | -
|
100 | | -1. Initialize pyenv and virtualenv. |
101 | | -
|
102 | | - ```bash |
103 | | - eval "$(pyenv init -)" |
104 | | - eval "$(pyenv virtualenv-init -)" |
105 | | - ``` |
106 | | -
|
107 | | -1. Use pyenv to install Python 3.7.4. |
108 | | -
|
109 | | - ```bash |
110 | | - pyenv install 3.7.4 |
111 | | - ``` |
112 | | -
|
113 | | -1. Install Asciidoctor. |
114 | | -
|
115 | | - ```bash |
116 | | - brew install asciidoctor |
117 | | - ```` |
118 | | -
|
119 | | -1. Install `ascii_binder` v0.1.15.1. |
120 | | -
|
121 | | - ```bash |
122 | | - sudo gem install ascii_binder -v 0.1.15.1 |
123 | | - ``` |
124 | | -
|
125 | | -1. Navigate into the `_build` directory and use the following command to install our custom `ascii_binder` package. |
126 | | -
|
127 | | - ```bash |
128 | | - cd _build/ |
129 | | - sudo gem install -V ./ascii_binder_pan-0.0.00.1.gem |
130 | | - ``` |
131 | | -
|
132 | | -1. Return to the root directory and run the `build_site.sh` script as follows |
133 | | -
|
134 | | - ```bash |
135 | | - cd .. |
136 | | - ./build_site.sh |
137 | | - ``` |
138 | | -
|
139 | | -1. Open the generated site using the following command. |
140 | | -
|
141 | | - ```bash |
142 | | - open output/_package/main/index.html |
143 | | - ``` |
| 13 | +Government docs will be moved to the new repo shortly. |
0 commit comments