feat: inital mdbook docs for rust-ceramic #282
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
3benbox
temporarily deployed
to
github-tests-2024
GitHub Actions
Inactive
nathanielc
requested changes
Mar 6, 2024
There was a problem hiding this comment.
Looking good a few comments:
- I think we should name the directory simply
bookI find the redundant name confusing - I want to make sure these docs are not immediately out of date as soon as we create them. To me that means either a) automate generating some content from the source (i.e. the help text) or b) Do not include any content that is already part of the binary but instead simply refer to it so it can't get out of sync. I would prefer option a but its more work so we can build up to that.
- How does this work in CI?
- Does this get deployed as a Github Pages book?
- Can we add a Makefile target to build the book?
- Is the
bookdirectory the generated content? If so can we add a Makefile target to check its been generated correctly like we do for the api server crates?
rust-ceramic/src/metrics.md
Outdated
| - `ceramic_store_value_insert_count_total`: Total number of values inserted into the store | ||
| - `ceramic_store_store_query_durations_[sum, buckets, count]`: Store query durations | ||
| - `ceramic_api_request_durations_[sum, buckets, count]`: API request durations | ||
| - `ceramic_api_api_info`: Information about the Ceramic API |
There was a problem hiding this comment.
Should we note that there are many more metrics and encourage operators to explore them via the /metrics endpoint? We can highlight these as the important ones but this is not an exhaustive list.
There was a problem hiding this comment.
Yeah, like the "help" I'd love a way to generate the metrics for the docs.
I don't see a way outside parsing all the source files.
Do you have any ideas how to make a rust command, or entrypoint, that would print the available metrics?
3benbox
temporarily deployed
to
github-tests-2024
GitHub Actions
Inactive
3benbox
temporarily deployed
to
github-tests-2024
GitHub Actions
Inactive
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.
Checkout the branch, change to the ./rust-ceramic directory and run
mdbook serve --opento view the contents.Took the same directory name as kermaik, happy to move it if it's confusing.
Closes WS1-1515