website: content updates for developer (#2426)

* chore(website/nav-data): sup to badge
```
            "badge": {
              "text": "OSS Only",
              "type": "outlined",
              "color": "neutral"
            }
```

* update previews to render developer UI

* Apply suggestions from code review

* update redirects

Co-authored-by: Kevin Wang <kwangsan@gmail.com>
Co-authored-by: HashiBot <62622282+hashibot-web@users.noreply.github.com>
This commit is contained in:
authored and GitHub committed 2022-09-15 10:27:10 -04:00
1 parent 53b5e532d5
commit 06370867c7
7 files changed
+44 -20

No files matched your search

+6 -1
View File
@@ -13,8 +13,10 @@ DOCKER_RUN_FLAGS=-it \
--volume "$(PWD)/redirects.js:/app/redirects.js" \
--volume "next-dir:/app/website-preview/.next" \
--volume "$(PWD)/.env:/app/.env" \
-e "REPO=boundary"
-e "REPO=boundary" \
-e "PREVIEW_MODE=io"
# Default: run this if working on the website locally to run in watch mode.
.PHONY: website
website:
@echo "==> Downloading latest Docker image..."
@@ -22,13 +24,16 @@ website:
@echo "==> Starting website..."
@docker run $(DOCKER_RUN_FLAGS) $(DOCKER_IMAGE)
# Use this if you have run `website/build-local` to use the locally built image.
.PHONY: website/local
website/local:
@echo "==> Starting website from local image..."
@docker run $(DOCKER_RUN_FLAGS) $(DOCKER_IMAGE_LOCAL)
# Run this to generate a new local Docker image.
.PHONY: website/build-local
website/build-local:
@echo "==> Building local Docker image"
@docker build https://github.com/hashicorp/dev-portal.git\#main \
-t $(DOCKER_IMAGE_LOCAL)
@@ -157,7 +157,7 @@ Boundary using the Boundary Desktop app.
You can also use these overrides to configure the [Terraform provider for
Boundary](https://registry.terraform.io/providers/hashicorp/boundary/):
Boundary](https://registry.terraform.io/providers/hashicorp/boundary):
```hcl
provider "boundary" {
@@ -15,7 +15,7 @@ Lastly, for instructions on how to upgrade an existing Boundary deployment to v0
## Boundary v0.8.0 Highlights
**Metrics and Health Endpoint:** Boundary is adding [Prometheus metrics](https://www.boundaryproject.io/docs/operations/metrics) to monitor the operations of workers and controllers,
**Metrics and Health Endpoint:** Boundary is adding [Prometheus metrics](/docs/oss/operations/metrics) to monitor the operations of workers and controllers,
as well as a [health endpoint](/docs/oss/operations/health) for controllers.
**Audit Event Logs:** We are expanding the audit event logs by increasing the captured [audit events](/docs/configuration/events/overview),
+1 -1
View File
@@ -9,7 +9,7 @@ description: And introduction to Boundary
HashiCorp Boundary is a tool for managing identity-based access for modern, dynamic infrastructure. Boundary’s workflow layers security controls and integrations on multiple levels monitoring and managing user access through:
- Tightly scoped identity-based permissions
- "Just-in-time" network and credential access for sessions via [HashiCorp Vault](https://vaultproject.io/)
- "Just-in-time" network and credential access for sessions via [HashiCorp Vault](https://www.vaultproject.io/)
- Single sign-on to target services and applications via external identity providers
- Access-as-code to automate the configuration of user permissions
- Automated discovery of target systems
+21 -6
View File
@@ -57,8 +57,13 @@
"path": "configuration/worker/pki-worker"
},
{
"title": "KMS Workers <sup>OSS Only</sup>",
"path": "configuration/worker/kms-worker"
"title": "KMS Workers",
"path": "configuration/worker/kms-worker",
"badge": {
"text": "OSS Only",
"type": "outlined",
"color": "neutral"
}
}
]
},
@@ -138,12 +143,22 @@
]
},
{
"title": "controller <sup>OSS Only</sup>",
"path": "configuration/controller"
"title": "controller",
"path": "configuration/controller",
"badge": {
"text": "OSS Only",
"type": "outlined",
"color": "neutral"
}
},
{
"title": "plugins <sup>OSS Only</sup>",
"path": "configuration/plugins"
"title": "plugins",
"path": "configuration/plugins",
"badge": {
"text": "OSS Only",
"type": "outlined",
"color": "neutral"
}
}
]
},
+3 -1
View File
@@ -6,6 +6,8 @@ PREVIEW_DIR=website-preview
CLONE_DIR=website-preview
# The product for which we are building the deploy preview
PRODUCT=boundary
# Preview mode, controls the UI rendered (either the product site or developer). Can be `io` or `developer`
PREVIEW_MODE=io
from_cache=false
@@ -28,4 +30,4 @@ fi
cd "$PREVIEW_DIR"
# Run the build:deploy-preview start script
REPO=$PRODUCT DEV_IO=$PRODUCT IS_CONTENT_PREVIEW=true HASHI_ENV=project-preview npm run build:deploy-preview
PREVIEW_MODE=$PREVIEW_MODE REPO=$PRODUCT HASHI_ENV=project-preview npm run build:deploy-preview
+11 -9
View File
@@ -1,25 +1,27 @@
# Repo which we are cloning and executing npm run build:deploy-preview within
REPO_TO_CLONE=dev-portal
# Set the subdirectory name for the dev-portal app
PREVIEW_DIR=website-preview
# The product for which we are running local preview mode
# The product for which we are building the deploy preview
PRODUCT=boundary
# Preview mode, controls the UI rendered (either the product site or developer). Can be `io` or `developer`
PREVIEW_MODE=io
should_pull=true
# Clone the dev-portal project, if needed
if [ ! -d "$PREVIEW_DIR" ]; then
echo "⏳ Cloning the dev-portal repo, this might take a while..."
git clone --depth=1 https://github.com/hashicorp/dev-portal.git "$PREVIEW_DIR"
echo "⏳ Cloning the $REPO_TO_CLONE repo, this might take a while..."
git clone --depth=1 https://github.com/hashicorp/$REPO_TO_CLONE.git "$PREVIEW_DIR"
should_pull=false
fi
cd "$PREVIEW_DIR"
# If the directory already existed, pull to ensure the dev-portal clone is fresh
if [ "$should_pull" = true ] && [ -d ".git" ]; then
git fetch origin main
git reset --hard origin/main
# If the directory already existed, pull to ensure the clone is fresh
if [ "$should_pull" = true ]; then
git pull origin main
fi
# Run the dev-portal content-repo start script
REPO=$PRODUCT PREVIEW_DIR="$PREVIEW_DIR" npm run start:local-preview
REPO=$PRODUCT PREVIEW_MODE=$PREVIEW_MODE npm run start:local-preview