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

v1 - Configure & Install docs-mobile.talawa.io Docusaurus Site #2674

Merged

Conversation

palisadoes
Copy link
Contributor

@palisadoes palisadoes commented Dec 27, 2024

What kind of change does this PR introduce?

These changes allow the creation of a new https://docs-mobile.talawa.io documentation website

Issue Number:

  • N/A

Did you add tests for your changes?

  • Yes

Snapshots/Videos:

  • N/A

If relevant, did you update the documentation?

  • Yes

Summary

Does this PR introduce a breaking change?

  • No

Other information

  • N/A

Have you read the contributing guide?

  • Yes

Summary by CodeRabbit

  • New Features

    • Introduced a new GitHub Actions workflow for automated deployment of the Docusaurus website.
    • Added a custom domain for the documentation site: docs-mobile.talawa.io.
    • Enhanced documentation with new tutorials on creating blog posts, documents, and pages.
  • Bug Fixes

    • Simplified workflow trigger conditions for better clarity.
  • Documentation

    • Comprehensive updates to the Talawa Mobile Documentation, including installation instructions and tutorials.
  • Style

    • New CSS styles for homepage features and global variables for customization.
  • Chores

    • Added .gitignore file for the docs directory to manage ignored files.

@palisadoes palisadoes added the ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files label Dec 27, 2024
Copy link
Contributor

coderabbitai bot commented Dec 27, 2024

Warning

Rate limit exceeded

@palisadoes has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 44 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

Reviewing files that changed from the base of the PR and between 335a366 and dccb9e4.

⛔ Files ignored due to path filters (11)
  • docs/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg is excluded by !**/*.jpeg
  • docs/docs/tutorial-extras/img/docsVersionDropdown.png is excluded by !**/*.png
  • docs/docs/tutorial-extras/img/localeDropdown.png is excluded by !**/*.png
  • docs/static/img/docusaurus-social-card.jpg is excluded by !**/*.jpg
  • docs/static/img/docusaurus.png is excluded by !**/*.png
  • docs/static/img/favicon.ico is excluded by !**/*.ico
  • docs/static/img/logo.svg is excluded by !**/*.svg
  • docs/static/img/markdown/misc/logo.png is excluded by !**/*.png
  • docs/static/img/undraw_docusaurus_mountain.svg is excluded by !**/*.svg
  • docs/static/img/undraw_docusaurus_react.svg is excluded by !**/*.svg
  • docs/static/img/undraw_docusaurus_tree.svg is excluded by !**/*.svg
📒 Files selected for processing (31)
  • .github/workflows/push-deploy-website.yml (1 hunks)
  • .github/workflows/push.yml (0 hunks)
  • docs/.gitignore (1 hunks)
  • docs/CNAME (1 hunks)
  • docs/README.md (1 hunks)
  • docs/blog/2019-05-28-first-blog-post.md (1 hunks)
  • docs/blog/2019-05-29-long-blog-post.md (1 hunks)
  • docs/blog/2021-08-01-mdx-blog-post.mdx (1 hunks)
  • docs/blog/2021-08-26-welcome/index.md (1 hunks)
  • docs/blog/authors.yml (1 hunks)
  • docs/blog/tags.yml (1 hunks)
  • docs/docs/intro.md (1 hunks)
  • docs/docs/tutorial-basics/_category_.json (1 hunks)
  • docs/docs/tutorial-basics/congratulations.md (1 hunks)
  • docs/docs/tutorial-basics/create-a-blog-post.md (1 hunks)
  • docs/docs/tutorial-basics/create-a-document.md (1 hunks)
  • docs/docs/tutorial-basics/create-a-page.md (1 hunks)
  • docs/docs/tutorial-basics/deploy-your-site.md (1 hunks)
  • docs/docs/tutorial-basics/markdown-features.mdx (1 hunks)
  • docs/docs/tutorial-extras/_category_.json (1 hunks)
  • docs/docs/tutorial-extras/manage-docs-versions.md (1 hunks)
  • docs/docs/tutorial-extras/translate-your-site.md (1 hunks)
  • docs/docusaurus.config.ts (1 hunks)
  • docs/sidebars.ts (1 hunks)
  • docs/src/components/HomepageFeatures/index.tsx (1 hunks)
  • docs/src/components/HomepageFeatures/styles.module.css (1 hunks)
  • docs/src/css/custom.css (1 hunks)
  • docs/src/pages/index.module.css (1 hunks)
  • docs/src/pages/index.tsx (1 hunks)
  • docs/src/pages/markdown-page.md (1 hunks)
  • docs/static/CNAME (1 hunks)

Walkthrough

This pull request introduces a comprehensive setup for the Talawa Mobile documentation website using Docusaurus. The changes include creating a new documentation site structure with GitHub Actions workflow for deployment, configuring blog and documentation features, and setting up a custom domain. The implementation covers various aspects such as internationalization, versioning, and creating sample content to demonstrate Docusaurus capabilities.

Changes

File/Directory Change Summary
.github/workflows/ Added push-deploy-website.yml for automated Docusaurus website deployment
docs/ Created full Docusaurus documentation site structure with blogs, tutorials, configuration files
docs/blog/ Added sample blog posts, author configurations, and tag definitions
docs/docs/ Introduced tutorial sections for Docusaurus basics and extras
docs/src/ Created React components, CSS modules, and page configurations
docs/CNAME Specified custom domain docs-mobile.talawa.io

Sequence Diagram

sequenceDiagram
    participant Developer
    participant GitHub Actions
    participant Docusaurus
    participant GitHub Pages

    Developer->>GitHub: Push changes to develop-postgres branch
    GitHub Actions->>Docusaurus: Build documentation site
    Docusaurus->>GitHub Actions: Generate static files
    GitHub Actions->>GitHub Pages: Deploy documentation
    GitHub Pages->>Developer: Website accessible at docs-mobile.talawa.io
Loading

Possibly related PRs

Poem

🐰 Docusaurus hops with glee,
Docs dancing, wild and free!
Workflows spin, pages gleam bright,
A rabbit's documentation delight!
Mobile knowledge takes its flight! 🚀


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.

@palisadoes palisadoes merged commit 6533d25 into PalisadoesFoundation:develop-postgres Dec 27, 2024
4 of 5 checks passed
Copy link

codecov bot commented Dec 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.98%. Comparing base (335a366) to head (dccb9e4).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                Coverage Diff                @@
##           develop-postgres    #2674   +/-   ##
=================================================
  Coverage             95.98%   95.98%           
=================================================
  Files                   187      187           
  Lines                  9887     9887           
=================================================
  Hits                   9490     9490           
  Misses                  397      397           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-sensitive-files-pr The contributor has a legitimate reason for editiing protected files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant