Skip to content
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

Nc docs/validations #8574

Merged
merged 5 commits into from
May 25, 2024
Merged

Nc docs/validations #8574

merged 5 commits into from
May 25, 2024

Conversation

dstala
Copy link
Member

@dstala dstala commented May 25, 2024

Change Summary

Provide summary of changes with issue number if any.

Change type

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Test/ Verification

Provide summary of changes.

Additional information / screenshots (optional)

Anything for maintainers to be made aware of

Copy link
Contributor

coderabbitai bot commented May 25, 2024

Warning

Rate Limit Exceeded

@dstala has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 54 minutes and 29 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between e416d18 and fd65ac0.

Walkthrough

The recent updates to NocoDB's form configuration enhance user guidance and validation capabilities. These changes include adding help text for required fields, configuring layout options for select fields, and implementing detailed field validations for various field types, such as text-based, numeric, date-based, and attachment fields. These enhancements aim to improve form usability and data integrity by providing clear instructions and robust validation mechanisms.

Changes

File(s) Change Summary
packages/noco-docs/docs/090.views/040.view-types/030.form.md Added help text for required fields and Checkbox behavior, updated layout configuration for select fields, introduced field validations for text-based, numeric, date-based, and attachment fields.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

Outside diff range and nitpick comments (1)
packages/noco-docs/docs/090.views/040.view-types/030.form.md (1)

Line range hint 233-243: Ensure consistent terminology for "pre-fill" throughout the document.

- pre-filling form fields with specific values by setting URL parameters.
+ pre-filling form fields with specific values by setting URL parameters.
- To construct a pre-filled form URL manually, ensure that the URL parameters are appropriately encoded in the following format: `?key1=value1&key2=value2`.
+ To construct a pre-filled form URL manually, ensure that the URL parameters are appropriately encoded in the following format: `?key1=value1&key2=value2`.
- `https://wh8s5w.noco.to/#/nc/form/66da06-f074-47af-ace7-fde46df55?Status=Qualification&Priority=Very+high` pre-fills the `Status` field with `Qualification` and the `Priority` field with `Very high`.
+ `https://wh8s5w.noco.to/#/nc/form/66da06-f074-47af-ace7-fde46df55?Status=Qualification&Priority=Very+high` pre-fills the `Status` field with `Qualification` and the `Priority` field with `Very high`.
- NocoDB provides an intuitive alternative approach to generate pre-filled URLs through the form builder.
+ NocoDB provides an intuitive alternative approach to generate pre-filled URLs through the form builder.
- Open the form builder and pre-fill the required form fields with the desired values.
+ Open the form builder and pre-fill the required form fields with the desired values.
- Toggle the `Enable Prefill` button to enable pre-filling.
+ Toggle the `Enable Prefill` button to enable pre-filling.
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between b5962ad and e416d18.
Files ignored due to path filters (4)
  • packages/noco-docs/static/img/v2/views/form-view/attachment-field-validations.png is excluded by !**/*.png, !**/*.png
  • packages/noco-docs/static/img/v2/views/form-view/date-field-validations.png is excluded by !**/*.png, !**/*.png
  • packages/noco-docs/static/img/v2/views/form-view/numeric-field-validations.png is excluded by !**/*.png, !**/*.png
  • packages/noco-docs/static/img/v2/views/form-view/text-field-validations.png is excluded by !**/*.png, !**/*.png
Files selected for processing (1)
  • packages/noco-docs/docs/090.views/040.view-types/030.form.md (1 hunks)
Additional Context Used
LanguageTool (19)
packages/noco-docs/docs/090.views/040.view-types/030.form.md (19)

Near line 111: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ...ared form. This is useful when you have a large number of options & want to limit the number of o...
Rule ID: LARGE_NUMBER_OF


Near line 171: Possible missing article found.
Context: ...r than or equal to the minimum value. - Value can be left empty to disable the valida...
Rule ID: AI_HYDRA_LEO_MISSING_THE


Near line 191: Possible missing article found.
Context: ...te part is considered for validation. - Value can be left empty to disable the valida...
Rule ID: AI_HYDRA_LEO_MISSING_THE


Near line 208: This phrase is redundant (‘G’ stands for ‘graphic’). Use simply “PNGs”.
Context: ...E types. Example - image/png Allows PNG images only - application/pdf Allows PDF d...
Rule ID: ACRONYM_TAUTOLOGY


Near line 225: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...t can be uploaded. 4. Limit file size Enter the maximum file size allowed for the a...
Rule ID: ENGLISH_WORD_REPEAT_BEGINNING_RULE


Near line 233: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ...offers a convenient feature that allows pre-filling form fields with specific values by set...
Rule ID: EN_WORD_COHERENCY


Near line 235: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ...ancing user experience. To construct a pre-filled form URL manually, ensure that the URL ...
Rule ID: EN_WORD_COHERENCY


Near line 237: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ...tatus=Qualification&Priority=Very+highpre-fills theStatusfield withQualification`...
Rule ID: EN_WORD_COHERENCY


Near line 239: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ...uitive alternative approach to generate pre-filled URLs through the form builder. 1. Open...
Rule ID: EN_WORD_COHERENCY


Near line 240: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ... builder. 1. Open the form builder and pre-fill the required form fields with the desir...
Rule ID: EN_WORD_COHERENCY


Near line 241: Consider adding a hyphen.
Context: ...ck on the Share button located in the top right corner. 3. Toggle the `Enable Public Vi...
Rule ID: TOP_LEFT_CORNER


Near line 243: Do not mix variants of the same word (‘pre-fill’ and ‘prefill’) within a single text.
Context: ...e the Enable Prefill button to enable pre-filling. 5. Click on the Copy Link button to ...
Rule ID: EN_WORD_COHERENCY


Near line 256: Do not mix variants of the same word (‘prefilled’ and ‘pre-filled’) within a single text.
Context: ...the shared form URL. Users can edit the prefilled fields in the form. In the image below,...
Rule ID: EN_WORD_COHERENCY


Near line 256: Possible missing article found.
Context: ...000andYearfield is prefilled with value2023`. ![Prefill default](/img/v...
Rule ID: AI_HYDRA_LEO_MISSING_THE


Near line 260: Do not mix variants of the same word (‘prefilled’ and ‘pre-filled’) within a single text.
Context: ...n the shared form URL but will hide the prefilled fields in the form from the user. In th...
Rule ID: EN_WORD_COHERENCY


Near line 260: Possible missing article found.
Context: ...000andYearfield is prefilled with value2023`. ![Prefill hide](/img/v2/view...
Rule ID: AI_HYDRA_LEO_MISSING_THE


Near line 264: Do not mix variants of the same word (‘prefilled’ and ‘pre-filled’) within a single text.
Context: ...n the shared form URL and will lock the prefilled fields as read-only. In the image below...
Rule ID: EN_WORD_COHERENCY


Near line 264: Possible missing article found.
Context: ...000andYearfield is prefilled with value2023`. ![Prefill lock](/img/v2/vie...
Rule ID: AI_HYDRA_LEO_MISSING_THE


Near line 269: Do not mix variants of the same word (‘prefilled’ and ‘pre-filled’) within a single text.
Context: ...he modes, the user can still change the prefilled fields by editing the URL. ::: ## Surv...
Rule ID: EN_WORD_COHERENCY

Markdownlint (79)
packages/noco-docs/docs/090.views/040.view-types/030.form.md (79)

12: Expected: 0 or 2; Actual: 1
Trailing spaces


17: Expected: 0 or 2; Actual: 1
Trailing spaces


41: Expected: 0 or 2; Actual: 1
Trailing spaces


66: Expected: 0 or 2; Actual: 1
Trailing spaces


67: Expected: 0 or 2; Actual: 1
Trailing spaces


77: Expected: 0 or 2; Actual: 1
Trailing spaces


123: Expected: 0 or 2; Actual: 1
Trailing spaces


165: Expected: 0 or 2; Actual: 1
Trailing spaces


209: Expected: 0 or 2; Actual: 1
Trailing spaces


235: Expected: 0 or 2; Actual: 1
Trailing spaces


239: Expected: 0 or 2; Actual: 1
Trailing spaces


264: Expected: 0 or 2; Actual: 1
Trailing spaces


273: Expected: 0 or 2; Actual: 1
Trailing spaces


275: Expected: 0 or 2; Actual: 1
Trailing spaces


276: Expected: 0 or 2; Actual: 1
Trailing spaces


44: Expected: 1; Actual: 2
Multiple consecutive blank lines


246: Expected: 1; Actual: 2
Multiple consecutive blank lines


288: Expected: 1; Actual: 2
Multiple consecutive blank lines


291: Expected: 1; Actual: 2
Multiple consecutive blank lines


12: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


21: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


31: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


40: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


49: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


52: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


59: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


62: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


65: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


73: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


86: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


105: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


110: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


163: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


184: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


204: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


229: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


232: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


255: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


272: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


281: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


292: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


14: null
Lists should be surrounded by blank lines


22: null
Lists should be surrounded by blank lines


42: null
Lists should be surrounded by blank lines


67: null
Lists should be surrounded by blank lines


75: null
Lists should be surrounded by blank lines


88: null
Lists should be surrounded by blank lines


93: null
Lists should be surrounded by blank lines


94: null
Lists should be surrounded by blank lines


112: null
Lists should be surrounded by blank lines


126: null
Lists should be surrounded by blank lines


127: null
Lists should be surrounded by blank lines


133: null
Lists should be surrounded by blank lines


142: null
Lists should be surrounded by blank lines


146: null
Lists should be surrounded by blank lines


149: null
Lists should be surrounded by blank lines


154: null
Lists should be surrounded by blank lines


165: null
Lists should be surrounded by blank lines


169: null
Lists should be surrounded by blank lines


171: null
Lists should be surrounded by blank lines


177: null
Lists should be surrounded by blank lines


186: null
Lists should be surrounded by blank lines


190: null
Lists should be surrounded by blank lines


191: null
Lists should be surrounded by blank lines


197: null
Lists should be surrounded by blank lines


206: null
Lists should be surrounded by blank lines


215: null
Lists should be surrounded by blank lines


216: null
Lists should be surrounded by blank lines


222: null
Lists should be surrounded by blank lines


240: null
Lists should be surrounded by blank lines


251: null
Lists should be surrounded by blank lines


252: null
Lists should be surrounded by blank lines


256: null
Lists should be surrounded by blank lines


276: null
Lists should be surrounded by blank lines


283: null
Lists should be surrounded by blank lines


153: null
Emphasis used instead of a heading


176: null
Emphasis used instead of a heading


196: null
Emphasis used instead of a heading


221: null
Emphasis used instead of a heading

dstala and others added 3 commits May 25, 2024 11:26
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@pranavxc pranavxc merged commit 985ca20 into develop May 25, 2024
1 check passed
@pranavxc pranavxc deleted the nc-docs/validations branch May 25, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants