-
Notifications
You must be signed in to change notification settings - Fork 182
DOC-13422-Eventing-Memory-Quota #4055
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
base: release/8.0
Are you sure you want to change the base?
Conversation
sarahlwelton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @Pallavi-Janardhan , can you please confirm that you're making the changes you want to be making in this PR? I can do a more thorough review once you're sure you're committing the right changes.
Thanks!
modules/install/pages/modules/architecture/database-change-protocol.adoc
Outdated
Show resolved
Hide resolved
Pallavi-Janardhan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have placed the newly created "eventing-memory-quota.adoc" doc under the "modules/learn/pages/buckets-memory-and-storage" directory and updated the cross-ref from sizing guidelines doc to this. Also have updated the nav.adoc (navigation doc).
Kindly review and let me know your comments or approve.
|
@sarahlwelton and @simon-dew can you please have a look at this and let me know if it is ok? If yes, kindly approve so that I can merge it. Thanks |
sarahlwelton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs a lot of work. Did you go through writing a doc plan for this work? I'm not sure that you're on the right track with how you chose to approach this, and we might have been able to guide you with a doc plan ahead of time.
modules/learn/pages/buckets-memory-and-storage/eventing-memory-quota.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/buckets-memory-and-storage/eventing-memory-quota.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/buckets-memory-and-storage/eventing-memory-quota.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/buckets-memory-and-storage/eventing-memory-quota.adoc
Outdated
Show resolved
Hide resolved
modules/learn/pages/buckets-memory-and-storage/eventing-memory-quota.adoc
Outdated
Show resolved
Hide resolved
sarahlwelton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This needs a lot of work. Did you go through writing a doc plan for this work? I'm not sure that you're on the right track with how you chose to approach this, and we might have been able to guide you with a doc plan ahead of time.
|
Hi @Pallavi-Janardhan Following up on the prior discussion, after further review I believe the following location is appropriate for a dedicated Eventing Memory Quota documentation page:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed with @Pallavi-Janardhan today, my comments are:
- Remove
eventing-memory-quota.adocfrom this PR and revert the changes to the navigation. In the Sizing Guidelines document, keep a link toxref:eventing:eventing-memory-quota.adoc(see below) and any style changes, following Sarah's comments. - Create a new PR in the docs-devex repo to add
eventing-memory-quota.adocto theeventingmodule, as suggested by @abhijpes.
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
…-quota.adoc Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
….adoc file in the docs-server repo
….adoc file in the docs-server repo
This will also build the related docs-devex branch
|
As discussed with Abhishek Jindal, I have added a section --> "Memory Management in Containerized vs Non-Containerized Environments", in the Eventing Memory Quota file. As discussed with my doc architects, am creating another PR just for the Eventing file that is going into another repo - docs-devex repo. The PR for that is --> couchbaselabs/docs-devex#555 Please do review both the PRs and let me know your comments/approval. Thanks and regards, |
sarahlwelton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still some issues. Thanks.
Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
Making few editorial review comments Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>
Co-authored-by: sarahlwelton <110928505+sarahlwelton@users.noreply.github.com>

DOC-13422
Created and added a new document for Eventing Memory Quota and linked it from the Sizing Guidelines document. Also modified the existing Sizing Guidelines doc.
Docs preview for Sizing Guidelines
and
Docs preview for Eventing Memory Quota
Preview credentials
NOTE For Writer: DO NOT Forget that this PR must be merged with the PR --> (couchbaselabs/docs-devex#555)