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

fix(samples): remove presence from samples page as presence is not public #4029

Merged
merged 5 commits into from
Dec 16, 2024

Conversation

sreenara
Copy link
Contributor

@sreenara sreenara commented Dec 16, 2024

COMPLETES # NA

This pull request addresses

the availability of the "Presence" samples page in our samples collection even though the plugin-presence is not available at this time. This is misleading for our developers.

by making the following changes

Remove the Presence samples page

Change Type

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Tooling change
  • Internal code refactor

The following scenarios were tested

Checked the samples page collection and ensured that the "Presence" page isn't listed any more.

I certified that

  • I have read and followed contributing guidelines

  • I discussed changes with code owners prior to submitting this pull request

  • I have not skipped any automated checks

  • All existing and new tests passed

  • I have updated the documentation accordingly


Make sure to have followed the contributing guidelines before submitting.

Summary by CodeRabbit

  • New Features

    • Updated documentation to reflect the removal of the "Presence" sample from the main content area.
    • Updated the samples index to remove the "Browser plugin presence" link.
  • Bug Fixes

    • Removed outdated links to enhance user navigation and clarity.
  • Chores

    • Deleted files related to the "Browser plugin presence" functionality, streamlining the documentation.

@sreenara sreenara requested a review from a team as a code owner December 16, 2024 04:21
Copy link

coderabbitai bot commented Dec 16, 2024

Walkthrough

This pull request involves the removal of the browser plugin presence sample from the documentation. The changes include deleting three files (app.js, index.html, and style.css) in the docs/samples/browser-plugin-presence/ directory and removing corresponding links from the main samples index pages. The removal appears to be a complete elimination of the presence sample from the documentation, suggesting a decision to discontinue or deprecate this specific code example.

Changes

File Change Summary
docs/index.html Removed link to "Presence" sample and "Presence API Reference"
docs/samples/index.html Removed list item for "Browser plugin presence" link
docs/samples/browser-plugin-presence/app.js Entire file deleted
docs/samples/browser-plugin-presence/index.html Entire file deleted
docs/samples/browser-plugin-presence/style.css Entire file deleted

Possibly related PRs

Poem

🐰 A presence sample, once so bright,
Hopped away into the coding night.
No more links, no more trace,
Just a memory in this digital space.
Farewell, little plugin, your journey's done! 🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b432dac and c862702.

📒 Files selected for processing (1)
  • docs/index.html (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/index.html

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.

CodeRabbit Configuration 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.

@sreenara sreenara added the validated If the pull request is validated for automation. label Dec 16, 2024
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-4029.d3m3l2kee0btzx.amplifyapp.com

Copy link

@pagour98 pagour98 left a comment

Choose a reason for hiding this comment

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

Changes LGTM, updated the branch to include latest next branch changes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we have to delete these files? We can remove the link to reach this page but what if we need these files in future we can keep them just not accessible for now

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Kesari3008 it's better to clean out files that aren't required and add them back when needed. This PR can be reverted to bring the files back.

@sreenara sreenara enabled auto-merge (squash) December 16, 2024 13:43
@sreenara sreenara merged commit 8278bd1 into webex:next Dec 16, 2024
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
validated If the pull request is validated for automation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants