Nc chore/docs link corrections #9411
Conversation
…e when accessing overview page directly
dosubot
bot
added
the
size:L
WalkthroughWalkthroughThe documentation for NocoDB has been updated with a focus on hyperlink modifications, including the conversion of relative links to absolute paths, adjustments to link structures for clarity, and consistent formatting across multiple documents. These changes ensure that the content remains accessible and organized, while the underlying functionality of the documentation is unchanged. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (4)
packages/noco-docs/docs/080.records/010.records-overview.md (2)
12-12: LGTM! Link updates look good.The changes to the links are consistent with the summary and appear to be correct.
Consider these minor style improvements:
- Replace "a variety of" with a more concise phrase, e.g., "several" or "multiple".
- Consider removing "new" from "create a new record" for brevity.
Example:
- You can perform a variety of actions to efficiently manage your data. To get started, you can [create a new record](/records/create-record) to input essential information. + You can perform several actions to efficiently manage your data. To get started, you can [create a record](/records/create-record) to input essential information.Tools
LanguageTool
[style] ~12-~12: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ... for data management. You can perform a variety of actions to efficiently manage your data...(A_VARIETY_OF)
[style] ~12-~12: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ...data. To get started, you can create a new record to input essen...(EN_WORDINESS_PREMIUM_NEW_RECORD)
18-22: Fix unordered list indentation.The Markdownlint tool has flagged issues with the indentation of the unordered list items. To resolve this, remove the single space before each list item.
Apply the following changes to fix the list indentation:
- - [Create Record](/records/create-record) - - [Modify an existing Record](/records/actions-on-record#update-record) - - [Bulk Update Records](/records/actions-on-record#bulk-update-records--) - - [Delete Record](/records/actions-on-record#delete-record-single) - - [Duplicate Record](/records/expand-record#duplicate-record) + - [Create Record](/records/create-record) + - [Modify an existing Record](/records/actions-on-record#update-record) + - [Bulk Update Records](/records/actions-on-record#bulk-update-records--) + - [Delete Record](/records/actions-on-record#delete-record-single) + - [Duplicate Record](/records/expand-record#duplicate-record)Tools
Markdownlint
18-18: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md (2)
Line range hint
96-125: New Litestream configuration section addedGreat addition of the Litestream configuration section! This provides crucial information for users who want to set up SQLite database backups using Litestream. The detailed explanations for each environment variable will be very helpful.
A minor suggestion for improvement:
Consider adding a brief explanation or link to documentation about what Litestream is and its benefits at the beginning of this section. This would help users who are unfamiliar with Litestream understand its purpose quickly.
Tools
LanguageTool
[uncategorized] ~87-~87: The official spelling of this programming framework is “Express.js”.
Context: ... allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resour...(NODE_JS)
87-87: Minor spelling suggestion for Express.jsThe documentation currently uses "ExpressJS" when referring to the Express.js framework.
Consider changing "ExpressJS" to "Express.js" for consistency with the official spelling. However, this is a minor issue and doesn't affect the overall quality of the documentation.
Tools
LanguageTool
[uncategorized] ~87-~87: The official spelling of this programming framework is “Express.js”.
Context: ... allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resour...(NODE_JS)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (17)
- packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md (1 hunks)
- packages/noco-docs/docs/030.workspaces/010.workspace-overview.md (3 hunks)
- packages/noco-docs/docs/040.bases/010.base-overview.md (1 hunks)
- packages/noco-docs/docs/060.table-operations/010.overview.md (1 hunks)
- packages/noco-docs/docs/080.records/010.records-overview.md (1 hunks)
- packages/noco-docs/docs/090.views/010.views-overview.md (1 hunks)
- packages/noco-docs/docs/090.views/040.view-types/010.grid.md (2 hunks)
- packages/noco-docs/docs/090.views/040.view-types/020.gallery.md (1 hunks)
- packages/noco-docs/docs/090.views/040.view-types/030.form.md (1 hunks)
- packages/noco-docs/docs/090.views/040.view-types/040.kanban.md (2 hunks)
- packages/noco-docs/docs/090.views/040.view-types/050.calendar.md (1 hunks)
- packages/noco-docs/docs/100.data-sources/010.data-source-overview.md (1 hunks)
- packages/noco-docs/docs/120.collaboration/010.collaboration-overview.md (1 hunks)
- packages/noco-docs/docs/130.automation/020.webhook/010.webhook-overview.md (1 hunks)
- packages/noco-docs/docs/140.account-settings/030.authentication/010.overview.md (1 hunks)
- packages/noco-docs/docs/160.developer-resources/010.rest-APIs/010.accessing-apis.md (1 hunks)
- packages/noco-docs/docs/160.developer-resources/020.webhook/010.webhook-overview.md (1 hunks)
Files skipped from review due to trivial changes (15)
- packages/noco-docs/docs/030.workspaces/010.workspace-overview.md
- packages/noco-docs/docs/040.bases/010.base-overview.md
- packages/noco-docs/docs/060.table-operations/010.overview.md
- packages/noco-docs/docs/090.views/010.views-overview.md
- packages/noco-docs/docs/090.views/040.view-types/010.grid.md
- packages/noco-docs/docs/090.views/040.view-types/020.gallery.md
- packages/noco-docs/docs/090.views/040.view-types/030.form.md
- packages/noco-docs/docs/090.views/040.view-types/040.kanban.md
- packages/noco-docs/docs/090.views/040.view-types/050.calendar.md
- packages/noco-docs/docs/100.data-sources/010.data-source-overview.md
- packages/noco-docs/docs/120.collaboration/010.collaboration-overview.md
- packages/noco-docs/docs/130.automation/020.webhook/010.webhook-overview.md
- packages/noco-docs/docs/140.account-settings/030.authentication/010.overview.md
- packages/noco-docs/docs/160.developer-resources/010.rest-APIs/010.accessing-apis.md
- packages/noco-docs/docs/160.developer-resources/020.webhook/010.webhook-overview.md
Additional context used
LanguageTool
packages/noco-docs/docs/080.records/010.records-overview.md
[style] ~12-~12: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ... for data management. You can perform a variety of actions to efficiently manage your data...(A_VARIETY_OF)
[style] ~12-~12: ‘new record’ might be wordy. Consider a shorter alternative.
Context: ...data. To get started, you can create a new record to input essen...(EN_WORDINESS_PREMIUM_NEW_RECORD)
packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md
[uncategorized] ~87-~87: The official spelling of this programming framework is “Express.js”.
Context: ... allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resour...(NODE_JS)
Markdownlint
packages/noco-docs/docs/080.records/010.records-overview.md
18-18: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
19-19: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
20-20: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
21-21: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (4)
packages/noco-docs/docs/080.records/010.records-overview.md (2)
21-22: LGTM! Link updates for Delete and Duplicate Record look good.The changes to the "Delete Record" and "Duplicate Record" links are consistent with the summary and appear to be intentional updates to the documentation structure.
Please run the following script to verify the existence and consistency of these updated links across the documentation:
Verification successful
Verification Successful: Updated Links Are Consistent
The updated links for "Delete Record" and "Duplicate Record" are correctly implemented and consistent across the documentation. No old links were found, confirming that the updates have been applied comprehensively.
- Delete Record:
/records/actions-on-record#delete-record-single- Duplicate Record:
/records/expand-record#duplicate-recordScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence and consistency of the updated links # Test 1: Check for the updated "Delete Record" link echo "Checking for the updated 'Delete Record' link:" rg --type md '/records/actions-on-record#delete-record-single' # Test 2: Check for the updated "Duplicate Record" link echo "Checking for the updated 'Duplicate Record' link:" rg --type md '/records/expand-record#duplicate-record' # Test 3: Check for any remaining old links that might need updating echo "Checking for any remaining old links:" rg --type md '/records/actions-on-record#delete-record\b' rg --type md '/records/actions-on-record#duplicate-record\b'Length of output: 4652
Tools
Markdownlint
21-21: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
22-22: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
20-20: Verify the updated link structure.The link for "Bulk Update Records" has been updated, but the addition of two hyphens at the end is unusual.
Please confirm that the link
/records/actions-on-record#bulk-update-records--is correct and functional. If it's intentional for the documentation system, it's fine. Otherwise, consider removing the extra hyphens.Tools
Markdownlint
20-20: Expected: 0; Actual: 1
Unordered list indentation(MD007, ul-indent)
packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md (2)
78-95: Improved documentation for Product Configuration environment variablesThe changes in this section enhance the clarity and completeness of the documentation:
- Table structure is more consistent and easier to read.
- New environment variables have been added, such as
NC_SANITIZE_COLUMN_NAMEandNC_TOOL_DIR.- Descriptions for existing variables have been expanded or clarified.
These improvements will help users better understand and configure the product.
Tools
LanguageTool
[uncategorized] ~87-~87: The official spelling of this programming framework is “Express.js”.
Context: ... allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resour...(NODE_JS)
Line range hint
1-125: Overall documentation improvementsThe changes made to this file significantly enhance the quality and comprehensiveness of the environment variables documentation:
- Improved formatting and consistency across all sections.
- Addition of new environment variables with clear descriptions.
- Introduction of the Litestream configuration section, providing valuable information for SQLite users.
These updates will greatly assist users in configuring and using NocoDB effectively.
Tools
LanguageTool
[uncategorized] ~87-~87: The official spelling of this programming framework is “Express.js”.
Context: ... allowed in the request body, based on [ExpressJS limits](https://expressjs.com/en/resour...(NODE_JS)
Signed-off-by: Pranav C <pranavxc@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
packages/noco-docs/package-lock.jsonis excluded by!**/package-lock.json,!**/*.jsonpackages/noco-docs/package.jsonis excluded by!**/*.json
Files selected for processing (1)
- .github/workflows/validate-docs-links.yml (1 hunks)
Additional context used
actionlint
.github/workflows/validate-docs-links.yml
14-14: label "aws" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Additional comments not posted (2)
.github/workflows/validate-docs-links.yml (2)
1-11: Workflow name and triggers look good.The workflow name is clear, and the triggers are well-defined. It's good that it's limited to the 'develop' branch and only runs when documentation files are changed.
12-14: Consider updating the runner label.The
awslabel for the self-hosted runner is not a standard GitHub-provided label. This might cause issues if the label is not properly configured in your self-hosted runner setup.To resolve this, you can either:
- Ensure that the
awslabel is correctly set up in your self-hosted runner configuration.- Use a more generic label like
linuxif that's applicable to your AWS runner.Example fix:
- runs-on: [self-hosted, aws] + runs-on: [self-hosted, linux]If you're intentionally using a custom
awslabel, you may want to document this in your project's contributor guidelines to avoid confusion.Tools
actionlint
14-14: label "aws" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 18.19.1 | ||
| - name: Build docs | ||
| run: | | ||
| cd packages/noco-docs | ||
| npm install | ||
| npm run generate | ||
| npm run remark:once |
There was a problem hiding this comment.
Consider enhancing job steps for better performance and reliability.
The current steps are good, but we can improve them:
- Add caching for npm dependencies to speed up the workflow.
- Use a specific npm version for consistency.
- Add error handling and artifact uploading for better debugging.
Here's an example of how you could enhance the job steps:
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18.19.1
cache: 'npm'
cache-dependency-path: packages/noco-docs/package-lock.json
- name: Install dependencies
run: |
cd packages/noco-docs
npm ci
- name: Build docs
run: |
cd packages/noco-docs
npm run generate
npm run remark:once
- name: Upload artifact
uses: actions/upload-artifact@v3
if: failure()
with:
name: docs-build
path: packages/noco-docs/distThese changes will:
- Cache npm dependencies
- Use
npm cifor more reliable installs - Separate installation and build steps
- Upload the built docs as an artifact if the job fails, aiding in debugging
| name: "Validate: Docs" | ||
|
|
||
| on: | ||
| # Triggered manually | ||
| workflow_dispatch: | ||
| pull_request: | ||
| types: [opened, reopened, synchronize, ready_for_review, labeled] | ||
| branches: [develop] | ||
| paths: | ||
| - "packages/noco-docs/**" | ||
|
|
||
| jobs: | ||
| validate-docs: | ||
| runs-on: [self-hosted, aws] | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| - uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 18.19.1 | ||
| - name: Build docs | ||
| run: | | ||
| cd packages/noco-docs | ||
| npm install | ||
| npm run generate | ||
| npm run remark:once |
There was a problem hiding this comment.
Consider additional best practices for GitHub Actions workflows.
The workflow is good overall, but here are some final suggestions to enhance it:
-
Add a timeout to the job to prevent long-running builds:
jobs: validate-docs: timeout-minutes: 10
-
Consider adding a concurrency group to cancel in-progress jobs when new commits are pushed:
concurrency: group: ${{ github.workflow }}-${{ github.ref }} cancel-in-progress: true
-
Add a step to report the status of the docs validation, which could be useful for PR checks:
- name: Report docs status if: always() uses: actions/github-script@v6 with: script: | const conclusion = '${{ job.status }}' === 'success' ? 'success' : 'failure'; github.rest.checks.create({ owner: context.repo.owner, repo: context.repo.repo, name: 'Docs Validation', head_sha: context.sha, status: 'completed', conclusion: conclusion, output: { title: 'Docs Validation Result', summary: 'The docs validation process has ' + (conclusion === 'success' ? 'passed' : 'failed') + '.' } })
These additions will make your workflow more robust and informative.
Tools
actionlint
14-14: label "aws" is unknown. available labels are "windows-latest", "windows-latest-8-cores", "windows-2022", "windows-2019", "ubuntu-latest", "ubuntu-latest-4-cores", "ubuntu-latest-8-cores", "ubuntu-latest-16-cores", "ubuntu-24.04", "ubuntu-22.04", "ubuntu-20.04", "macos-latest", "macos-latest-xl", "macos-latest-xlarge", "macos-latest-large", "macos-14-xl", "macos-14-xlarge", "macos-14-large", "macos-14", "macos-14.0", "macos-13-xl", "macos-13-xlarge", "macos-13-large", "macos-13", "macos-13.0", "macos-12-xl", "macos-12-xlarge", "macos-12-large", "macos-12", "macos-12.0", "macos-11", "macos-11.0", "self-hosted", "x64", "arm", "arm64", "linux", "macos", "windows". if it is a custom label for self-hosted runner, set list of labels in actionlint.yaml config file
(runner-label)
Nc chore/docs link corrections Signed-off-by: Pranav C <pranavxc@gmail.com>
Change Summary
Provide summary of changes with issue number if any.
Change type
Test/ Verification
Provide summary of changes.
Additional information / screenshots (optional)
Anything for maintainers to be made aware of