-
Notifications
You must be signed in to change notification settings - Fork 48
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
Add the ability to pull in docs from valkey-doc
#22
Merged
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
Signed-off-by: Kyle J. Davis <[email protected]>
Signed-off-by: Kyle J. Davis <[email protected]>
madolson
approved these changes
Apr 10, 2024
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.
Generally lgtm
stockholmux
added a commit
that referenced
this pull request
Apr 10, 2024
* adds commands to top nav (#19) Signed-off-by: Kyle J. Davis <[email protected]> * Add the ability to pull in docs from `valkey-doc` (#22) * adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> * update code owners file (#23) Add kyle to the code owners file Signed-off-by: Kyle J. Davis <[email protected]> * feat: Update the about page to include a brief history of the project. (#18) * feat: Update the about page to include a brief history of the project. Signed-off-by: Pranav Ramesh <[email protected]> * feat: Use markdown instead of HTML & update wording of history Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> Signed-off-by: Pranav Ramesh <[email protected]> Co-authored-by: Pranav Ramesh <[email protected]>
AMoo-Miki
pushed a commit
to AMoo-Miki/valkey-website
that referenced
this pull request
Apr 11, 2024
* adds commands to top nav (valkey-io#19) Signed-off-by: Kyle J. Davis <[email protected]> * Add the ability to pull in docs from `valkey-doc` (valkey-io#22) * adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> * update code owners file (valkey-io#23) Add kyle to the code owners file Signed-off-by: Kyle J. Davis <[email protected]> * feat: Update the about page to include a brief history of the project. (valkey-io#18) * feat: Update the about page to include a brief history of the project. Signed-off-by: Pranav Ramesh <[email protected]> * feat: Use markdown instead of HTML & update wording of history Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Pranav Ramesh <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> Signed-off-by: Pranav Ramesh <[email protected]> Co-authored-by: Pranav Ramesh <[email protected]>
AMoo-Miki
pushed a commit
to AMoo-Miki/valkey-website
that referenced
this pull request
Apr 11, 2024
* adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> (cherry picked from commit 19d2253)
stockholmux
added a commit
that referenced
this pull request
Apr 11, 2024
* adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]> (cherry picked from commit 19d2253)
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.
Description
docs/management/persistence.md
_includes
folder for the markdown docs fromvalkey-doc
in the workflowWhat does the
doc-import
layout do?This allows the consumption of the existing markdown files in
valkey-doc
by stripping out the existing frontmatter (which is not relevant). Alternately, if there isn't front matter on the file (it doesn't start with---
) it still works.This way we can keep the concerns separated:
valkey-doc
contains content,valkey-website
contains metadata and site specific (templates, forward, etc.) information.Issues Resolved
n/a
Check List
--signoff
By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.