Initialize an mkdocs-based Jedis doc site #3998
Closed
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
sazzad16
changed the title
|
@joshrotenberg Thanks for working on this! |
uglide
requested changes
Oct 21, 2024
sazzad16
requested changes
Oct 22, 2024
There was a problem hiding this comment.
The GitHub home page contains a link to this file. If we remove this file, we should also change the link in README.md in root folder.
There was a problem hiding this comment.
This file should be ignored from spell check.
| @@ -0,0 +1,15 @@ | |||
| # Jedis Documentation | |||
|
|
|||
| This documenation uses [MkDocs](https://www.mkdocs.org/) to generate the static site. | |||
|
|
||
| See [mkdocs.yml](../mkdocs.yml) for the configuration. | ||
|
|
||
| To develop the documentation locally, you can use the included [Dockefile](ockerfile) to build a container with all the |
There was a problem hiding this comment.
This file should be ignored from spell check.
Merged
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.
This PR unifies the current content in
docsand the Wiki into a single, GitHub pages hosted Jedis documentation portal. So far it's a minimal effort combo of the two plus a few extra links, with the intent that it can continue to grow into a single point of reference for all things Jedis. For the most part it mirrors the lettuce implementation in spirit.If merged,
Pageswill also need to be enabled for the repo. Go toSettings,Pagesin the left hand navigation, and selectGitHub Actionsin theBuild and deploymentdropdown.My fork has an up to date version running here as an example: https://joshrotenberg.com/jedis/