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

documentation(documentation-website): Update API bench link on docs w… #965

Merged
merged 20 commits into from
May 5, 2024

Conversation

arnabnandy7
Copy link
Contributor

@arnabnandy7 arnabnandy7 commented May 4, 2024

The Pull Request is ready

Overview

Review points

Documentation-Website

  • mobile view is usable
  • desktop view is usable
  • no a-tags are used directly (NavLink, MailLink, ExternalLink instead)
  • all new texts are added to the translation files (at least the english one)
  • tests have been added (if required)
  • shared code has been extracted in a different file

Notes

…ebsite

Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958.
@github-actions github-actions bot added documentation Improvements or additions to documentation component: documentation-website related to the project's website, not the framework component: framework related to the project framework, not the website component: tooling Something to help make our life easier component: examples Something related to the provided examples component: translation None-code task, that deals with translation or texts component: history-microservice Anything related to the database access microservice component: history-website anything related to the data history display page component: cli The cli tool of api-bench component: mindmap Adjusting the mindmap component: desktop A desktop app to run the framework with a UI component: continuous-integration github action related labels May 4, 2024
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for contributing!
Please make sure the actions pass. Once your pull request has been merged, you will automatically be added to the contributor's list on the website.
If you want to be shouted out on Linkedin, have a look for the shoutout issue of the specific version.

You can also find us on slack at idrinth-api-bench.

Copy link
Contributor

coderabbitai bot commented May 4, 2024

Warning

Rate Limit Exceeded

@Idrinth has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 5 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 815e309 and cdbba58.

Walkthrough

CodeRabbit assimilates the collective shift in namespace from @idrinth/api-bench to @idrinth-api-bench/api-bench across various components. This restructuring ensures uniformity and clarity in project identity, enhancing the efficiency of the codebase.

Changes

Files Change Summary
documentation-website/cypress/e2e/... Updated title comparisons in Cypress tests to reflect the new namespace.
documentation-website/src/components/header.tsx Updated URLs related to npm packages and Docker images to use the new namespace.

🌌🐇
To the stars we hop with code so bright,
Across the galaxy, our changes take flight.
From @idrinth to @idrinth-api-bench, we revamp,
In the universe of code, we are the champ.
Celebrate the shift, for we enhance,
In the cosmic dance of code, we prance. 🚀🌟


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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

…ebsite.

Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
coderabbitai[bot]
coderabbitai bot previously approved these changes May 4, 2024
…ebsite.

Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
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: 6

documentation-website/cypress/e2e/sponsors.cy.ts Outdated Show resolved Hide resolved
documentation-website/language/it.yml Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/middlewares.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/autowiring.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/contributors.cy.ts Outdated Show resolved Hide resolved
documentation-website/src/components/header.tsx Outdated Show resolved Hide resolved
Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
coderabbitai[bot]
coderabbitai bot previously approved these changes May 4, 2024
Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
@arnabnandy7
Copy link
Contributor Author

@coderabbitai review

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: 1

documentation-website/cypress/e2e/middlewares.cy.ts Outdated Show resolved Hide resolved
Copy link
Member

@Idrinth Idrinth left a comment

Choose a reason for hiding this comment

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

Please remove all changes that are unrelated to the new github url, they don't make sense yet, due to the packages not yet existing

@arnabnandy7
Copy link
Contributor Author

Please remove all changes that are unrelated to the new github url, they don't make sense yet, due to the packages not yet existing

Hi @Idrinth I've already removed changes I made in package json files. Any other files you're pointing?

@Idrinth
Copy link
Member

Idrinth commented May 5, 2024

Please remove all changes that are unrelated to the new github url, they don't make sense yet, due to the packages not yet existing

Hi @Idrinth I've already removed changes I made in package json files. Any other files you're pointing?

Great! May be in readmes for package names as well - it's pretty much ONLY about the github link so far, since everything else needs to be published under the new name first

@@ -118,7 +118,7 @@ npm run coai
<Lang lnkey={'contributing.code.setup.description'}/>
</p>
<Code language='bash'>{`
git clone https://github.com/idrinth/api-bench
git clone https://github.com/idrinth-api-bench/api-bench
Copy link
Contributor

Choose a reason for hiding this comment

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

you can keep this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure

@marikadeveloper
Copy link
Contributor

marikadeveloper commented May 5, 2024

Please remove all changes that are unrelated to the new github url, they don't make sense yet, due to the packages not yet existing

Hi @Idrinth I've already removed changes I made in package json files. Any other files you're pointing?

Hi @arnabnandy7 you should only keep changes related to the new github repo url, the npm package is still https://www.npmjs.com/package/@idrinth/api-bench it's not changed yet. So no need to change the stuff in the localization files or the website's header yet :) I left you some comments of what you can keep.

@arnabnandy7
Copy link
Contributor Author

Please remove all changes that are unrelated to the new github url, they don't make sense yet, due to the packages not yet existing

Hi @Idrinth I've already removed changes I made in package json files. Any other files you're pointing?

Hi @arnabnandy7 you should only keep changes related to the new github repo url, the npm package is still https://www.npmjs.com/package/@idrinth/api-bench it's not changed yet. So no need to change the stuff in the localization files or the website's header yet :) I left you some comments of what you can keep.

That's great @marikadeveloper thanks for your support. I'll make the changes.

Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
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: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 71452f3 and d2ab6e9.
Files selected for processing (2)
  • documentation-website/language/it.yml (1 hunks)
  • documentation-website/src/components/header.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • documentation-website/language/it.yml
  • documentation-website/src/components/header.tsx

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: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between d2ab6e9 and 1f7f0d2.
Files selected for processing (1)
  • documentation-website/src/components/header.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • documentation-website/src/components/header.tsx

coderabbitai[bot]
coderabbitai bot previously approved these changes May 5, 2024
@arnabnandy7
Copy link
Contributor Author

@Idrinth @marikadeveloper it's done, please review once

documentation-website/src/pages/usage/routes/index.tsx Outdated Show resolved Hide resolved
documentation-website/src/pages/quick-start/index.tsx Outdated Show resolved Hide resolved
documentation-website/src/components/header.tsx Outdated Show resolved Hide resolved
documentation-website/src/components/default-meta.tsx Outdated Show resolved Hide resolved
documentation-website/language/it.yml Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/home.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/contributors.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/contributing.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/code-of-conduct.cy.ts Outdated Show resolved Hide resolved
documentation-website/cypress/e2e/autowiring.cy.ts Outdated Show resolved Hide resolved
Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
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: 1

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1f7f0d2 and 7817efc.
Files selected for processing (5)
  • documentation-website/cypress/e2e/autowiring.cy.ts (1 hunks)
  • documentation-website/cypress/e2e/contributors.cy.ts (1 hunks)
  • documentation-website/cypress/e2e/middlewares.cy.ts (1 hunks)
  • documentation-website/cypress/e2e/sponsors.cy.ts (1 hunks)
  • documentation-website/src/components/header.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (4)
  • documentation-website/cypress/e2e/autowiring.cy.ts
  • documentation-website/cypress/e2e/contributors.cy.ts
  • documentation-website/cypress/e2e/sponsors.cy.ts
  • documentation-website/src/components/header.tsx
Additional Context Used
GitHub Check Runs (1)
lint failure (2)

documentation-website/cypress/e2e/middlewares.cy.ts: [warning] 14-14:
Trailing spaces not allowed

Path-based Instructions (1)
documentation-website/cypress/e2e/middlewares.cy.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

Comment on lines 14 to 15
cy.title().should('eq', 'Middlewares | Usage | ' +
'@idrinth/api-bench',);
Copy link
Contributor

Choose a reason for hiding this comment

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

Trailing spaces detected. CodeRabbit recommends removal for cleaner code.

-    cy.title().should('eq', 'Middlewares | Usage | ' +  
+    cy.title().should('eq', 'Middlewares | Usage | ' +

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
cy.title().should('eq', 'Middlewares | Usage | ' +
'@idrinth/api-bench',);
cy.title().should('eq', 'Middlewares | Usage | ' +
'@idrinth/api-bench',);

Refs Issue idrinth-api-bench#958 - This commit updates the API bench link on the documentation website to reflect the changes made in Issue idrinth-api-bench#958
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: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 7817efc and 815e309.
Files selected for processing (1)
  • documentation-website/cypress/e2e/middlewares.cy.ts (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • documentation-website/cypress/e2e/middlewares.cy.ts

@arnabnandy7
Copy link
Contributor Author

@Idrinth it's done, please let me know if more to be done.

Copy link

sonarqubecloud bot commented May 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@Idrinth Idrinth merged commit 76ab11f into idrinth-api-bench:the-one May 5, 2024
24 of 27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: cli The cli tool of api-bench component: continuous-integration github action related component: desktop A desktop app to run the framework with a UI component: documentation-website related to the project's website, not the framework component: examples Something related to the provided examples component: framework related to the project framework, not the website component: history-microservice Anything related to the database access microservice component: history-website anything related to the data history display page component: mindmap Adjusting the mindmap component: tooling Something to help make our life easier component: translation None-code task, that deals with translation or texts documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Update api-bench link on docs website
3 participants