-
Notifications
You must be signed in to change notification settings - Fork 8
Renew documentaion site #921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
marcushohlbein
wants to merge
43
commits into
main
Choose a base branch
from
feature/update-documentaion
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
9d6e65b
add docs to repo
6450a9b
feat(docs): add build script for documentation and update package names
b811baf
chore: update commitlint configuration and add apphosting.yaml for do…
e638ca7
chore(docs): skip browser downloads for documentation build
5b8bff5
chore(docs): enhance build process by skipping Playwright installatio…
6ef1ff4
chore(docs): refine build command by removing unnecessary ellipsis
8c5c6c1
chore(docs): add environment variable for documentation build process
83c248b
chore(docs): update documentation build process to include new enviro…
b6388a7
chore(docs): remove apphosting.yaml as it is no longer needed for the…
cbb8746
chore(docs): update apphosting.yaml to refine build and run commands,…
18805bf
chore(docs): update output directory in apphosting.yaml for documenta…
87cad52
chore(docs): update build command in apphosting.yaml and specify pnpm…
251b5a2
chore(docs): specify Node.js and pnpm engine requirements in package.…
6452b94
chore(docs): update apphosting.yaml, and add start script in package.…
ce3774f
chore(docs): disable auto-installing peer dependencies in .npmrc and …
823209c
chore(docs): update .npmrc to set resolution mode and specify pnpm ve…
58180b1
chore(docs): update pnpm version in package.json and remove resolutio…
941daaa
chore(docs): update pnpm version specification in package.json
b16d91c
chore(docs): update pnpm version and set frozen-lockfile to false in …
14b9c34
chore(docs): set resolution mode to highest in .npmrc and update pnpm…
6b488a0
chore(docs): update pnpm version and remove angular dist directory fr…
06f2ca1
chore(docs): add dev script
ed5e367
chore: add preinstall script and log agent information in prepare.js
de8c167
chore: remove preinstall and prepare scripts
4f9c382
chore: add preinstall and prepare scripts
f3838a9
chore(docs): adjustments
49cdbb3
chore(docs): update build and run commands in apphosting.yaml
1cc3cec
chore(docs): modify apphosting configuration and update root director…
c4b7896
chore(docs): adjustments
1a2c705
chore: fixes
6ba7c9c
chore(docs): update apphosting configuration, pnpm version, and enhan…
000c61c
chore(docs): refine apphosting configuration with output directory an…
b320e87
chore: remove apphosting and Firebase configuration files
9bfb30f
chore: add diagnostic step to verify build context in cloudbuild.yaml
6fb12eb
ci: add GitHub Actions workflow for docs deployment
7f754da
chore: merge main into feature/update-documentaion, resolve conflicts
Copilot 6e27305
ci: use service account key auth and hardcode GCP project ID
b42969d
ci: add workflow_dispatch trigger for manual runs
28d3cca
fix(docs): update documentation link text for clarity
c53d0f0
fix: remove COPY of generated docs/.source from Dockerfile
135392f
fix: correct standalone server path and remove full node_modules copy
fe1eeab
fix(docs): enhance documentation link text for improved user experience
a874b24
fix(docs): simplify documentation link text for clarity
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| { | ||
| "extends": ["@commitlint/config-conventional"], | ||
| "rules": { | ||
| "scope-enum": [2, "always", ["angular", "angular-formly", "core", "react", "tokens", "release"]], | ||
| "scope-enum": [2, "always", ["angular", "angular-formly", "core", "docs", "react", "tokens", "release"]], | ||
| "scope-case": [2, "always", "lower-case"] | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| name: Deploy Docs to Cloud Run | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - feature/update-documentaion | ||
| paths: | ||
| - 'docs/**' | ||
| - 'core/**' | ||
| - 'tokens/**' | ||
| - 'package.json' | ||
| - 'pnpm-workspace.yaml' | ||
| - 'pnpm-lock.yaml' | ||
| workflow_dispatch: | ||
|
|
||
| env: | ||
| REGION: europe-west1 | ||
| SERVICE: catalyst-docs | ||
| IMAGE: europe-west1-docker.pkg.dev/haiilo-docs-487312/catalyst-docs/catalyst-docs | ||
|
|
||
| jobs: | ||
| deploy: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: read | ||
| id-token: write | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Auth to Google Cloud | ||
| uses: google-github-actions/auth@v2 | ||
| with: | ||
| credentials_json: ${{ secrets.GCP_SERVICE_ACCOUNT_KEY }} | ||
|
|
||
| - name: Setup gcloud | ||
| uses: google-github-actions/setup-gcloud@v2 | ||
|
|
||
| - name: Configure Docker for Artifact Registry | ||
| run: gcloud auth configure-docker ${{ env.REGION }}-docker.pkg.dev --quiet | ||
|
|
||
| - name: Build and push Docker image | ||
| run: | | ||
| docker build -f docs/Dockerfile \ | ||
| -t ${{ env.IMAGE }}:${{ github.sha }} \ | ||
| -t ${{ env.IMAGE }}:latest \ | ||
| . | ||
|
|
||
| docker push --all-tags ${{ env.IMAGE }} | ||
|
|
||
| - name: Deploy to Cloud Run | ||
| run: | | ||
| gcloud run deploy ${{ env.SERVICE }} \ | ||
| --image=${{ env.IMAGE }}:${{ github.sha }} \ | ||
| --region=${{ env.REGION }} \ | ||
| --platform=managed \ | ||
| --allow-unauthenticated \ | ||
| --port=3000 \ | ||
| --min-instances=1 \ | ||
| --max-instances=3 \ | ||
| --memory=512Mi \ | ||
| --quiet |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| // #region agent log | ||
| fetch('http://127.0.0.1:7245/ingest/a53d94c4-bb14-4c00-8cee-e4c7e61eb768',{method:'POST',headers:{'Content-Type':'application/json','X-Debug-Session-Id':'67fbf2'},body:JSON.stringify({sessionId:'67fbf2',runId:'pre-fix',hypothesisId:'H1',location:'.pnpmfile.cjs:2',message:'pnpmfile loaded',data:{node:process.version},timestamp:Date.now()})}).catch(()=>{}); | ||
| // #endregion | ||
|
|
||
| let firstPackageLogged = false; | ||
|
|
||
| module.exports = { | ||
| hooks: { | ||
| readPackage(pkg) { | ||
| if (!firstPackageLogged) { | ||
| firstPackageLogged = true; | ||
| // #region agent log | ||
| fetch('http://127.0.0.1:7245/ingest/a53d94c4-bb14-4c00-8cee-e4c7e61eb768',{method:'POST',headers:{'Content-Type':'application/json','X-Debug-Session-Id':'67fbf2'},body:JSON.stringify({sessionId:'67fbf2',runId:'pre-fix',hypothesisId:'H2',location:'.pnpmfile.cjs:13',message:'pnpm readPackage hook called',data:{name:pkg.name||null,version:pkg.version||null},timestamp:Date.now()})}).catch(()=>{}); | ||
| // #endregion | ||
| } | ||
| return pkg; | ||
| }, | ||
| }, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| steps: | ||
| # Diagnostic: verify build context has the full repo | ||
| - name: 'alpine' | ||
| args: ['ls', '-la', '/workspace/'] | ||
|
|
||
| # Build the container image from repo root using docs/Dockerfile | ||
| - name: 'gcr.io/cloud-builders/docker' | ||
| dir: '.' | ||
| args: | ||
| - 'build' | ||
| - '-f' | ||
| - 'docs/Dockerfile' | ||
| - '-t' | ||
| - '${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}:$COMMIT_SHA' | ||
| - '-t' | ||
| - '${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}:latest' | ||
| - '.' | ||
|
|
||
| # Push to Artifact Registry | ||
| - name: 'gcr.io/cloud-builders/docker' | ||
| args: | ||
| - 'push' | ||
| - '--all-tags' | ||
| - '${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}' | ||
|
|
||
| # Deploy to Cloud Run | ||
| - name: 'gcr.io/cloud-builders/gcloud' | ||
| args: | ||
| - 'run' | ||
| - 'deploy' | ||
| - '${_SERVICE_NAME}' | ||
| - '--image=${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}:$COMMIT_SHA' | ||
| - '--region=${_REGION}' | ||
| - '--platform=managed' | ||
| - '--allow-unauthenticated' | ||
| - '--port=3000' | ||
| - '--min-instances=0' | ||
| - '--max-instances=3' | ||
| - '--memory=512Mi' | ||
|
|
||
| substitutions: | ||
| _REGION: europe-west1 | ||
| _REPO_NAME: catalyst-docs | ||
| _SERVICE_NAME: catalyst-docs | ||
|
|
||
| images: | ||
| - '${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}:$COMMIT_SHA' | ||
| - '${_REGION}-docker.pkg.dev/$PROJECT_ID/${_REPO_NAME}/${_SERVICE_NAME}:latest' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| { | ||
| "dirPath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert", | ||
| "filePath": "src/components/cat-alert/cat-alert.tsx", | ||
| "fileName": "cat-alert.tsx", | ||
| "readmePath": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert/readme.md", | ||
| "usagesDir": "/Users/marcus/Haiilo/catalyst/core/src/components/cat-alert/usage", | ||
| "tag": "cat-alert", | ||
| "readme": "# cat-alert\n\n\n", | ||
| "overview": "Informs user about important changes or conditions in the interface. Use this\ncomponent if you need to capture user’s attention in a prominent way.", | ||
| "usage": {}, | ||
| "docs": "Informs user about important changes or conditions in the interface. Use this\ncomponent if you need to capture user’s attention in a prominent way.", | ||
| "docsTags": [], | ||
| "encapsulation": "shadow", | ||
| "dependents": [], | ||
| "dependencies": [ | ||
| "cat-icon" | ||
| ], | ||
| "dependencyGraph": { | ||
| "cat-alert": [ | ||
| "cat-icon" | ||
| ] | ||
| }, | ||
| "props": [ | ||
| { | ||
| "name": "color", | ||
| "type": "\"danger\" | \"none\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", | ||
| "complexType": { | ||
| "original": "'primary' | 'secondary' | 'danger' | 'success' | 'warning' | 'none'", | ||
| "resolved": "\"danger\" | \"none\" | \"primary\" | \"secondary\" | \"success\" | \"warning\"", | ||
| "references": {} | ||
| }, | ||
| "mutable": false, | ||
| "attr": "color", | ||
| "reflectToAttr": true, | ||
| "docs": "The color palette of the alert.", | ||
| "docsTags": [ | ||
| { | ||
| "name": "default", | ||
| "text": "'primary'" | ||
| } | ||
| ], | ||
| "default": "'primary'", | ||
| "values": [ | ||
| { | ||
| "value": "danger", | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "value": "none", | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "value": "primary", | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "value": "secondary", | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "value": "success", | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "value": "warning", | ||
| "type": "string" | ||
| } | ||
| ], | ||
| "optional": false, | ||
| "required": false, | ||
| "getter": false, | ||
| "setter": false | ||
| }, | ||
| { | ||
| "name": "icon", | ||
| "type": "string | undefined", | ||
| "complexType": { | ||
| "original": "string", | ||
| "resolved": "string | undefined", | ||
| "references": {} | ||
| }, | ||
| "mutable": false, | ||
| "attr": "icon", | ||
| "reflectToAttr": false, | ||
| "docs": "The name of an icon to be displayed in the alert.", | ||
| "docsTags": [], | ||
| "values": [ | ||
| { | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "type": "undefined" | ||
| } | ||
| ], | ||
| "optional": true, | ||
| "required": false, | ||
| "getter": false, | ||
| "setter": false | ||
| }, | ||
| { | ||
| "name": "noIcon", | ||
| "type": "boolean", | ||
| "complexType": { | ||
| "original": "boolean", | ||
| "resolved": "boolean", | ||
| "references": {} | ||
| }, | ||
| "mutable": false, | ||
| "attr": "no-icon", | ||
| "reflectToAttr": false, | ||
| "docs": "Whether the icon of the alert is deactivated.", | ||
| "docsTags": [ | ||
| { | ||
| "name": "default", | ||
| "text": "false" | ||
| } | ||
| ], | ||
| "default": "false", | ||
| "values": [ | ||
| { | ||
| "type": "boolean" | ||
| } | ||
| ], | ||
| "optional": false, | ||
| "required": false, | ||
| "getter": false, | ||
| "setter": false | ||
| } | ||
| ], | ||
| "methods": [], | ||
| "events": [], | ||
| "styles": [], | ||
| "slots": [], | ||
| "parts": [], | ||
| "listeners": [] | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we use these docs.json files? couldn't figure out so far how are they generated and where they are used. if we use it we need to fix relative paths I think