Skip to content

Commit 8db4d41

Browse files
authored
Go from "Artifact Repository" to "Package Firewall" (#269)
This change updates the page names, slugs, language, and links to use the "Package Firewall" product term instead of "Artifact Repository." This update is made in concert with changes in the `aviary` repo and their releases will need to be coordinated. Additional changes made include: * Update `CONTRIBUTING.md` to specify how to initialize submodules * Add a site announcement about the Phylum to Veracode transition
1 parent d296115 commit 8db4d41

File tree

13 files changed

+42
-30
lines changed

13 files changed

+42
-30
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,23 +65,34 @@ Here's how to set up the Phylum `documentation` repository for local development
6565
git clone [email protected]:phylum-dev/documentation.git
6666
```
6767

68-
2. Create a branch for local development:
68+
2. Initialize and pull the git submodules
69+
70+
```sh
71+
## Populate submodules initially
72+
git submodule update --init --recursive
73+
74+
## Update submodules during development
75+
git fetch --all
76+
git pull --recurse-submodules
77+
```
78+
79+
3. Create a branch for local development:
6980

7081
```sh
7182
git checkout -b <name-of-your-branch>
7283
```
7384

7485
Now you can make your changes locally.
7586

76-
3. Commit your changes and push your branch to GitHub:
87+
4. Commit your changes and push your branch to GitHub:
7788

7889
```sh
7990
git add .
8091
git commit -m "Description of the changes goes here"
8192
git push --set-upstream origin <name-of-your-branch>
8293
```
8394

84-
4. Submit a pull request (PR) through the GitHub website
95+
5. Submit a pull request (PR) through the GitHub website
8596

8697
## Release Process
8798

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Artifact Repositories
1+
# Package Firewalls
22

3-
Phylum for artifact repositories allows users to configure their artifact
3+
Phylum Package Firewalls allows users to configure their artifact
44
repositories and/or package managers to block untrusted packages.
55

66
## How It Works
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# API
22

3-
This section provides additional instructions for usage of Phylum's Artifact
4-
Repository API. The full API is documented on [Swagger].
3+
This section provides additional instructions for usage of Phylum's Package
4+
Firewall API. The full API is documented on [Swagger].
55

6-
[Swagger]: https://swagger.phylum.io/?urls.primaryName=Artifact+Repository+API
6+
[Swagger]: https://swagger.phylum.io/?urls.primaryName=Package+Firewall+API
77

88
## Authentication
99

10-
The Artifact Repository API expects authentication in the basic auth format. The
10+
The Package Firewall API expects authentication in the basic auth format. The
1111
username is optional and provides context for which group should be used for the
1212
request. The group must either be the group name itself, for standalone groups,
1313
or the organization and group name combined using a `/`.
@@ -35,5 +35,5 @@ of the SHA256-HMAC of the response body, generated with the shared secret
3535
provided when registering the webhook. This checksum **must** be validated
3636
before accepting the authority of new webhook events.
3737

38-
[register webhook endpoint]: https://swagger.phylum.io/?urls.primaryName=Artifact+Repository+API#/default/add_webhook
38+
[register webhook endpoint]: https://swagger.phylum.io/?urls.primaryName=Package+Firewall+API#/default/add_webhook
3939
[package check endpoint]: https://swagger.phylum.io/?urls.primaryName=API#/Organizations/organizations_group_packages_check
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)