boost/website-v2
2
0
Fork 0
mirror of https://github.com/boostorg/website-v2.git synced 2026-01-19 04:42:17 +00:00
Code Issues Projects Releases Wiki Activity

Fix JFrog Artifactory download link and add docs

Browse Source 
- Remove extra slash
- Add setting for the minimum Artifactory version
- Document Artifactory environment variables and download process
- Update tests
This commit is contained in:
Lacey Williams Henschel
2024-01-10 11:12:27 -08:00
committed by Lacey Henschel
parent 8942892a5c
commit 330d53426d
6 changed files with 38 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/env_vars.md
View File

@@ -36,6 +36,19 @@ This project uses environment variables to configure certain aspects of the appl
- For **local development**, obtain valid value from the Boost team.
- In **deployed environments**, the valid value is set in `kube/boost/values.yaml` (or the environment-specific yaml file).
## Boost Release Downloads Settings
### `ARTIFACTORY_URL`
- Base API endpoint for accessing the JFrog Artifactory release downloads. This is NOT the base URL for the downloads themselves.
- For **local development**, there is a default value in `config/settings.py`
- In **deployed environments**, the valid value is set in `kube/boost/values.yaml` (or the environment-specific yaml file).
### `MIN_ARTIFACTORY_RELEASE`
- The lowest version of Boost with its downloads stored in JFrog Artifactory
- Hard-coded in `config/settings.py` in all environments
## Boost Google Calendar settings
### `BOOST_CALENDAR`

12
docs/release_downloads.md Normal file
View File

@@ -0,0 +1,12 @@
# Boost Release Downloads
## Artifactory
- Populate the release downloads by running `./manage.py import_artifactory_release_data`. See [Management Commands](./commands.md#import_artifactory_release_data) for more information.
- Downloads for new versions populate as part of the new version import process
- Existing data can be refreshed by running `./manage.py import_artifactory_release_data` in the desired environment
- Environment variables: `ARTIFACTORY_URL` and `MIN_ARTIFACTORY_RELEASE`. See the [Envrionment Variables](./env_vars.md) for more information.
The Artifactory API URL in `ARTIFACTORY_URL` allows us to retrieve the data about the downloads from the Artifactory API.
The URLs for the downloads themselves are retrieved from the URLs provided to us by the Artifactory API. We don't generate the download links ourselves.