Doc - Follow file name conventions of main docs, move to Tutorials #108
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
sleto-it
approved these changes
Apr 4, 2018
sleto-it
changed the title
ewoutp
suggested changes
Apr 5, 2018
| @@ -102,7 +102,7 @@ This setting specifies the type of storage engine used for all servers | |||
| in the cluster. | |||
| Possible values are: | |||
|
|
|||
| - `MMFiles` To use the MMfiles storage engine. | |||
| - `MMFiles` To use the MMFiles storage engine. | |||
There was a problem hiding this comment.
I don't like this change. IMO it becomes confusing, since the possible value is case sensitive.
So even if the rest of the documentation uses MMfiles, I'll still prefer to keep MMFiles here.
There was a problem hiding this comment.
I changed it from MMfiles to MMFiles, isn't that what you prefer? In the API, the storage engine names are all lower case IIRC, but we use MMFiles and RocksDB in the docs in most places if it doesn't have to be verbatim.
| - [Upgrading](./upgrading.md) | ||
| The ArangoDB Kubernetes Operator (`kube-arangodb`) is a set of two operators | ||
| that you deploy in your Kubernetes cluster to manage deployments of the | ||
| ArangoDB database and provide `PersistenVolumes` on local storage of your |
There was a problem hiding this comment.
PersistentVolumes (looks like we have that wrong in the entire document)
There was a problem hiding this comment.
Good catch, I didn't see the missing T.
| @@ -1,7 +1,7 @@ | |||
| # Storage | |||
|
|
|||
| An ArangoDB cluster relies heavily on fast persistent storage. | |||
| The ArangoDB operator uses `PersistenVolumeClaims` to deliver | |||
| The ArangoDB Kubernetes Operator uses `PersistenVolumeClaims` to deliver | |||
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.
Some changes as discussed with Santo.
Also see arangodb/arangodb#5014
@ewoutp Is this a good general description of what kube-arangodb is?
https://github.com/arangodb/kube-arangodb/compare/docs-integration?expand=1#diff-f7213dcd3b2930325722b1d1627b0152
Should the file names of the design docs be changed as well to follow CamelCase convention as used by our main documentation?