Public documentation about persistence #1259
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
|
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-1259.surge.sh 🎊 |
giograno
force-pushed
the
persistence-data
branch
6 times, most recently
from
1a1253e
to
4328b7d
Compare
giograno
requested review from
joe4dev,
sannya-singal,
ackdav,
HarshCasper,
pinzon,
dominikschubert,
MEPalma,
thrau,
baermat,
bentsku,
viren-nadkarni,
macnev2013,
silv-io,
lukqw,
steffyP,
simonrw,
alexrashed,
cloutierMat,
dfangl,
Morijarti and
pandomic
as code owners
Avoids dropping the new line at the end of the file and the
order changes in the YAML frontmatter
The only things left is the limitations in the user guides.
giograno
force-pushed
the
persistence-data
branch
from
985eaef
to
70989de
Compare
HarshCasper
approved these changes
May 17, 2024
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 adds automatically generated documentation about persistence support to our docs.
Everything is generated from the Persistence Catalog on Notion.
A [Python script] builds a JSON file in the
datafolder basically collecting the available data on Notion.This JSON file is used to build an overview table that summarizes the state of persistence support for every service (here).
Furthermore, we use Hugo taxonomies to add a persistence tag in every service page (e.g., here).
A click on the tag redirects to the overview of the persistence support.
To implement these tags, we automatically parse all the service pages and add a new entry in the YAML front matter.
The tag is only displayed for the supported services.
Similarly to the API coverage updates, we have a pipeline that periodically checks for changes (things should change in the Notion table).