Skip to content

Commit d77fdf2

Browse files
committed
chore: update Getting Started link to Quickstart tutorial
Change the Getting Started link in documentation preview to point to the Quickstart tutorial at /tutorials/quickstart instead of the previous location at /start/first-workspace.
1 parent 65dba2c commit d77fdf2

File tree

2 files changed

+5
-45
lines changed

2 files changed

+5
-45
lines changed

.github/docs/actions/docs-core/action.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ runs:
381381
# Generate standard document links
382382
INDEX_URL="$PREVIEW_URL"
383383
INSTALL_URL="$PREVIEW_URL/install"
384-
GETTING_STARTED_URL="$PREVIEW_URL/start/first-workspace"
384+
GETTING_STARTED_URL="$PREVIEW_URL/tutorials/quickstart"
385385
386386
# Store variables for later steps
387387
echo "pr_number=$PR_NUMBER" >> $GITHUB_OUTPUT
@@ -1051,7 +1051,7 @@ runs:
10511051
GH_COMMENT+="\n### Quick Links\n\n"
10521052
GH_COMMENT+="- [Main Docs](${{ steps.context-info.outputs.preview_url }})\n"
10531053
GH_COMMENT+="- [Installation Guide](${{ steps.context-info.outputs.install_url }})\n"
1054-
GH_COMMENT+="- [Getting Started](${{ steps.context-info.outputs.getting_started_url }})\n\n"
1054+
GH_COMMENT+="- [Quickstart](${{ steps.context-info.outputs.getting_started_url }})\n\n"
10551055
fi
10561056
10571057
# Always add the documentation validation status section

.github/workflows/docs-unified.yaml

Lines changed: 3 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ jobs:
124124
### Quick Links
125125
- [Main Docs](https://coder.com/docs/@${{ steps.docs-core-setup.outputs.sanitized_branch }})
126126
- [Installation Guide](https://coder.com/docs/@${{ steps.docs-core-setup.outputs.sanitized_branch }}/install)
127-
- [Getting Started](https://coder.com/docs/@${{ steps.docs-core-setup.outputs.sanitized_branch }}/start/first-workspace)
127+
- [Quickstart](https://coder.com/docs/@${{ steps.docs-core-setup.outputs.sanitized_branch }}/tutorials/quickstart)
128128
129129
<sub>⏳ Validating documentation...</sub>
130130
@@ -177,48 +177,8 @@ jobs:
177177
echo "Vale installed successfully"
178178
vale --version
179179
180-
# Run Vale inline for better integration with the rest of the workflow
181-
- name: Run Vale style checks
182-
id: vale-check
183-
if: steps.docs-core-setup.outputs.needs_vale == 'true' && steps.docs-core-setup.outputs.has_changes == 'true'
184-
shell: bash
185-
run: |
186-
echo "::group::Running Vale style checks"
187-
188-
# Parse JSON array from docs-core output
189-
CHANGED_FILES_JSON='${{ steps.docs-core-setup.outputs.changed_files }}'
190-
191-
# Handle empty or null arrays
192-
if [ "$CHANGED_FILES_JSON" == "[]" ] || [ "$CHANGED_FILES_JSON" == "null" ]; then
193-
echo "No files to check"
194-
echo "status=success" >> $GITHUB_OUTPUT
195-
echo "message=No files to check" >> $GITHUB_OUTPUT
196-
echo "::endgroup::"
197-
exit 0
198-
fi
199-
200-
# Extract files to check
201-
FILES_TO_CHECK=$(echo "$CHANGED_FILES_JSON" | jq -r 'join(" ")')
202-
echo "Files to check: $FILES_TO_CHECK"
203-
204-
# Run Vale on the changed files
205-
VALE_OUTPUT=$(vale --no-exit --output=JSON --config=.github/docs/vale/.vale.ini $FILES_TO_CHECK)
206-
VALE_EXIT_CODE=$?
207-
208-
# Store results
209-
if [ $VALE_EXIT_CODE -eq 0 ]; then
210-
echo "Vale check passed: No style issues found"
211-
echo "status=success" >> $GITHUB_OUTPUT
212-
echo "message=No style issues found" >> $GITHUB_OUTPUT
213-
else
214-
ISSUE_COUNT=$(echo "$VALE_OUTPUT" | jq '. | length')
215-
echo "Vale found $ISSUE_COUNT style issues"
216-
echo "$VALE_OUTPUT" | jq -r '.[] | "\(.Path):\(.Line):\(.Column) - \(.Message) (\(.Check))"'
217-
echo "status=warning" >> $GITHUB_OUTPUT
218-
echo "message=Found $ISSUE_COUNT style issues" >> $GITHUB_OUTPUT
219-
fi
220-
221-
echo "::endgroup::"
180+
# Vale style checking is now fully integrated into the docs-core action
181+
# No need to run Vale separately in this file
222182

223183
# Run the main validation with all tools installed
224184
- name: Run documentation validation

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy