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/calendar #7998

Merged
merged 5 commits into from Apr 2, 2024
Merged

Nc docs/calendar #7998

merged 5 commits into from Apr 2, 2024

Conversation

dstala
Copy link
Member

@dstala dstala commented Mar 28, 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

Summary by CodeRabbit

  • New Features
    • Introduced a new Calendar View for visualizing data in various formats (day, week, month, year) within NocoDB.
    • Enhanced guidance for creating views, including specific instructions for Kanban and Calendar views.
  • Documentation
    • Updated the Views Overview to include the Calendar View.
    • Added detailed instructions for selecting fields when creating Kanban and Calendar views.
    • Documented the functionalities available in the Calendar View, such as drag-and-drop rearrangement and customization options.

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Walkthrough

Walkthrough

The recent updates to the NocoDB documentation introduce and detail the new Calendar View feature. This enhancement allows users to visualize their data in a calendar format, offering capabilities such as drag-and-drop rearrangement, viewing in various time frames, and comprehensive operations like creating, renaming, and customizing within the Calendar view. These changes are aimed at enriching user guidance and expanding the versatility of data visualization in NocoDB.

Changes

File Path Change Summary
.../views-overview.md Added a new Calendar View to the list of view types.
.../create-view.md Updated instructions for creating views, including selecting fields for Kanban and Calendar views.
.../view-types/050.calendar.md Introduced the Calendar View feature, detailing functionalities like drag-and-drop, viewing formats, and operations.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2e132bf and 691d7b4.
Files ignored due to path filters (8)
  • packages/noco-docs/static/img/v2-unannotated/views/create-view-1.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/day-scale.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/fields-menu.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/markers.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/month-scale.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/week-scale.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/calendar/year-scale.png is excluded by !**/*.png
  • packages/noco-docs/static/img/v2/views/create-view-1.png is excluded by !**/*.png
Files selected for processing (3)
  • packages/noco-docs/docs/090.views/010.views-overview.md (1 hunks)
  • packages/noco-docs/docs/090.views/020.create-view.md (1 hunks)
  • packages/noco-docs/docs/090.views/040.view-types/050.calendar.md (1 hunks)
Additional comments (1)
packages/noco-docs/docs/090.views/010.views-overview.md (1)
  • 24-24: Adding the Calendar View to the list of supported view types is a valuable update for users. It's important to ensure that the link provided (view-types/calendar) is functional and leads to the correct documentation page. If not already done, verify that the corresponding documentation page exists and is accessible.

Comment on lines +10 to +14
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Fill view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
Copy link
Contributor

Choose a reason for hiding this comment

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

The instructions for creating new views, including Kanban and Calendar views, are clear and concise. However, there's a minor grammatical issue and a suggestion for clarity:

  • Consider changing "Fill view name" to "Enter the view name" for clarity.
  • For consistency with other documentation and general readability, consider using "or" in lowercase within the phrase "Date OR DateTime field".
3. Enter the view name in the pop-up modal.
   - For Kanban view, select the `Single select` field to be used as the Kanban field.
-  - For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
+  - For Calendar view, select the `Date` or `DateTime` field to be used as the Calendar field.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Fill view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` OR `DateTime` field to be used as the Calendar field.
1. Click on `+ New View` button below `table name`.
2. Select view type from the dropdown modal.
3. Enter the view name in the pop-up modal.
- For Kanban view, select the `Single select` field to be used as the Kanban field.
- For Calendar view, select the `Date` or `DateTime` field to be used as the Calendar field.

keywords: ['NocoDB Calendar', 'Calendar View', 'Calendar board', 'Calendar view operations']
---

Calendar View allows you to visualise your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.
Copy link
Contributor

Choose a reason for hiding this comment

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

The introduction to the Calendar View feature is well-written and informative. However, consider using "visualize" instead of "visualise" to maintain consistency with American English spelling used in the rest of the documentation.

- Calendar View allows you to visualise your data in a calendar format.
+ Calendar View allows you to visualize your data in a calendar format.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Calendar View allows you to visualise your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.
Calendar View allows you to visualize your data in a calendar format. You can easily rearrange the records by dragging and dropping them to different dates. You can also visualise the records in a day, week, month, or year format. This section will cover all the operations that can be performed on the Calendar view.

Comment on lines +39 to +40
### Year
Year view allows you to see a birds-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.
Copy link
Contributor

Choose a reason for hiding this comment

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

The description of the Year view is clear, but there's a minor grammatical suggestion to improve clarity:

  • Consider changing "birds-eye view" to "bird's-eye view" for grammatical correctness.
- Year view allows you to see a birds-eye view of the records for the entire year.
+ Year view allows you to see a bird's-eye view of the records for the entire year.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
### Year
Year view allows you to see a birds-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.
### Year
Year view allows you to see a bird's-eye view of the records for the entire year. Blue badge on the date indicates that there are records on that date. You can click on the date to see the records for that date.

Comment on lines +47 to +50
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicise or Underline.
Copy link
Contributor

Choose a reason for hiding this comment

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

The instructions for customizing the record label are clear and detailed. However, there's a minor spelling inconsistency:

  • Consider using "Italicize" instead of "Italicise" to maintain consistency with American English spelling.
- You can choose to format the field as Bold, Italicise or Underline.
+ You can choose to format the field as Bold, Italicize or Underline.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicise or Underline.
You can customize the record label that appears on the calendar. To do this, click on the `Fields` menu on the toolbar. In the dropdown that appears
- Use toggle to enable or disable the fields that you want to display on the calendar.
- Use reorder to change the order of the fields that you want to display on the calendar.
- Use format menu options to customize the display of the fields on the calendar. You can choose to format the field as Bold, Italicize or Underline.

@pranavxc pranavxc merged commit 463fb9a into develop Apr 2, 2024
1 check passed
@pranavxc pranavxc deleted the nc-docs/calendar branch April 2, 2024 08:28
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