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

docs: Fix outdated Apama plugin documentation #2996

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

albinsuresh
Copy link
Contributor

@albinsuresh albinsuresh commented Jul 15, 2024

Proposed changes

  1. Fix broken link to test project zip
  2. Use up-to-date screenshots
  3. Redirect more to the example repo documentation

I'm even wondering if we should get rid of the whole content and replace it with just some links to the examples repository maintained by the Apama team.

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue


Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@reubenmiller reubenmiller added the documentation Improvements or additions to documentation label Jul 15, 2024
@albinsuresh
Copy link
Contributor Author

Should get rid of the whole content and replace it with just some links to the examples repository maintained by the Apama team?

@reubenmiller
Copy link
Contributor

Should get rid of the whole content and replace it with just some links to the examples repository maintained by the Apama team?

We'll keep the docs as there are now (with these fixes etc.). Referencing out to the examples repo also doesn't seem like a great solution either...but we can re-evaluate this decision later.

Copy link
Contributor

@reubenmiller reubenmiller left a comment

Choose a reason for hiding this comment

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

Approved. Thanks for the proactive cleanup

Copy link
Contributor

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
476 0 3 476 100 1h12m21.058594999s

@albinsuresh albinsuresh added this pull request to the merge queue Jul 15, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 15, 2024
@reubenmiller reubenmiller added this pull request to the merge queue Jul 15, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Jul 15, 2024
@reubenmiller reubenmiller added this pull request to the merge queue Jul 15, 2024
Merged via the queue into thin-edge:main with commit 39c4b5b Jul 15, 2024
31 checks passed
@albinsuresh albinsuresh deleted the doc/apama-doc-fix branch August 7, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants