chore(docs): update doc/config.md to reflect 3.0 changes #922
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andrewazores
previously approved these changes
Jul 18, 2024
tthvo
reviewed
Jul 19, 2024
tthvo
reviewed
Jul 19, 2024
tthvo
reviewed
Jul 19, 2024
tthvo
reviewed
Jul 19, 2024
tthvo
reviewed
Jul 19, 2024
tthvo
reviewed
Jul 19, 2024
There was a problem hiding this comment.
Looks good!! I have some small comments. Btw, maybe also update this section:
diff --git a/docs/config.md b/docs/config.md
index cbf4aff..1e567fc 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -1,5 +1,5 @@
## Configuring Cryostat
-The operator creates and manages a Deployment of [Cryostat](https://github.com/cryostatio/cryostat) when the user creates or updates a `Cryostat` object. Only one `Cryostat` object should exist in the operator's namespace at a time. There are a few options available in the `Cryostat` spec that control how Cryostat is deployed.
+The operator creates and manages a Deployment of [Cryostat](https://github.com/cryostatio/cryostat) when the user creates or updates a `Cryostat` object. Only one `Cryostat` object should exist in a namespace at a time. There are a few options available in the `Cryostat` spec that control how Cryostat is deployed.
|
Do we also want to mention the deprecation of |
I'd rather save changes like that for release notes and CHANGELOGs. READMEs and other docs content should just stay up-to-date with the sources they're checked in with, IMO. |
Make sense! Thanks! Then, those are my only comments^^ |
andrewazores
previously approved these changes
Aug 7, 2024
tthvo
reviewed
Aug 7, 2024
mwangggg
force-pushed
the
899-update-docs
branch
from
a55c62b to
02f2300
Compare
mwangggg
force-pushed
the
899-update-docs
branch
from
02f2300 to
f917845
Compare
ebaron
approved these changes
Aug 9, 2024
mergify bot
pushed a commit
that referenced
this pull request
Aug 9, 2024
* update examples in config to v1beta2 * fix outdated links and info * update info * fix storage/database typo * reviews * make bundle update (cherry picked from commit 56bfead) # Conflicts: # bundle/manifests/cryostat-operator.clusterserviceversion.yaml
7 tasks
andrewazores
added a commit
that referenced
this pull request
Aug 12, 2024
ebaron
pushed a commit
that referenced
this pull request
Sep 9, 2024
…) (#929) * chore(docs): update doc/config.md to reflect 3.0 changes (#922) * update examples in config to v1beta2 * fix outdated links and info * update info * fix storage/database typo * reviews * make bundle update (cherry picked from commit 56bfead) # Conflicts: # bundle/manifests/cryostat-operator.clusterserviceversion.yaml * fixup! chore(docs): update doc/config.md to reflect 3.0 changes (#922) --------- Co-authored-by: Ming Yu Wang <[email protected]> Co-authored-by: Andrew Azores <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Welcome to Cryostat! 👋
Before contributing, make sure you have:
mainbranch[chore, ci, docs, feat, fix, test]git commit -S -m "YOUR_COMMIT_MESSAGE"Fixes: #899