Skip to content

Commit 9d33377

Browse files
committed
Merge branch 'main' into DOC-5158
2 parents d63f1af + 3e1eda5 commit 9d33377

File tree

2,282 files changed

+101352
-51591
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,282 files changed

+101352
-51591
lines changed

.github/workflows/redisvl_docs_sync.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,15 @@ jobs:
107107
108108
# Convert jupyter notebooks to markdown
109109
jupyter nbconvert --to markdown build/jupyter_execute/user_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/ 2>/dev/null
110+
jupyter nbconvert --to markdown build/jupyter_execute/user_guide/release_guide/*.ipynb --output-dir redis_vl_hugo/user_guide/release_guide/ 2>/dev/null
110111
jupyter nbconvert --to markdown build/jupyter_execute/overview/cli.ipynb --output-dir redis_vl_hugo/overview/ 2>/dev/null
111112
112113
# Prepare markdown files
113114
rsync -a ./build/markdown/api/ ./redis_vl_hugo/api/ --exclude=index.md
114115
cp ./build/markdown/overview/installation.md ./redis_vl_hugo/overview/installation.md
115116
116117
# Format markdown files
118+
shopt -s globstar
117119
markdown_pages=(./redis_vl_hugo/**/*.md)
118120
119121
for markdown_page in "${markdown_pages[@]}"; do
@@ -208,19 +210,21 @@ jobs:
208210
# Format _index.md pages
209211
cp ./build/markdown/api/index.md ./redis_vl_hugo/api/_index.md
210212
cp ./build/markdown/user_guide/index.md ./redis_vl_hugo/user_guide/_index.md
213+
cp ./build/markdown/user_guide/release_guide/index.md ./redis_vl_hugo/user_guide/release_guide/_index.md
211214
cp ./build/markdown/overview/index.md ./redis_vl_hugo/overview/_index.md
212215
213216
index_markdown_pages=(
214217
./redis_vl_hugo/api/_index.md
215218
./redis_vl_hugo/user_guide/_index.md
219+
./redis_vl_hugo/user_guide/release_guide/_index.md
216220
./redis_vl_hugo/overview/_index.md
217221
)
218222
219223
for index_markdown_page in "${index_markdown_pages[@]}"; do
220224
format "${index_markdown_page}"
221225
222226
# Fix relrefs by removing .md extension and references to numbered pages
223-
sed -E -i 's/\.md/\//g; s/\([0-9]+_/\(/g' "${index_markdown_page}"
227+
sed -E -i 's/\.md/\//g; s/\([0-9]{2}_/\(/g; s/\/index\//\//g' "${index_markdown_page}"
224228
done
225229
226230
# Rename user guides to strip leading numbers from filename

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,16 @@
22

33
PRs are merged first to the `main` branch of this repo.
44
Periodically, the docs team will merge `main` into `latest`, which will make the changes visible on the docs site.
5-
Please be patient, as there may be a lag of several days before `main` is merged into `latest`. If you want to see your changes before they're merged to `latest`, you can see them on https://redis.io/docs/staging/dev/.
5+
Please be patient, as there may be a lag of several days before `main` is merged into `latest`. If you want to see your changes before they're merged to `latest`, you can see them on https://redis.io/docs/staging/dev/.
66
If your PR is urgent, let the docs team know in the PR comments, and we will do our best to accommodate.
77

88
## Site template files and folders
99

10-
* **/archetypes**: A Markdown file needs to have some front matter. An archetype defines which front matter is used when using `hugo new content`. Right now, the only supported archetype is the default one. **Note:** We might want to add additional archetypes in the future because most of our pages contain additional meta data properties like `linkTitle`.
10+
* **/archetypes**: A Markdown file needs to have some front matter. An archetype defines which front matter is used when using `hugo new content`. Right now, the only supported archetype is the default one. **Note:** We might want to add additional archetypes in the future because most of our pages contain additional meta data properties like `linkTitle`.
1111
* **/content**: This folder contains the markdown files. We will have the subfolders like `/develop`, `/integrate`, and `/operate`
1212
* **/assets**: CSS files, site-wide icons, and images.
1313
* **/data**: Data files that are accessed by Hugo and rendered with the help of short codes or partials.
14-
* **/layouts/partials**: HTML templates that are used across sites. Examples are TOCs, breadcrumbs, or headers.
14+
* **/layouts/partials**: HTML templates that are used across sites. Examples are TOCs, breadcrumbs, or headers.
1515
* **/layouts/$type**: Each page type has at least the following templates to implement `single.html` and `list.html`. The `single` template is used to render a discrete page. The `list` template is used to render a collection of related pages (e.g., all sub-pages).
1616
* **/layouts/home.html**: The home page of the site, that is, the page that is displayed when you open the root path.
1717
* **/layouts/404.html**: The default 404 page.
@@ -20,8 +20,7 @@ If your PR is urgent, let the docs team know in the PR comments, and we will do
2020
* **/static**: Any static files that need to be accessed by the site, e.g., CSS or JavaScript.
2121
* **/package.json**: Node.js dependencies. Tailwind, for example, is installed via the Node package manager (`npm`).
2222
* **/config.toml**: Hugo's site configuration, like the root path and menu items. Hugo can access configuration elements when rendering the site. So you can define custom configuration settings here.
23-
* **/syntax.css**: Hugo supports syntax highlighting via shortcodes. The highlighter is configured via this CSS file.
24-
* **/Makefile**: We use make to wrap some Hugo commands and to add addtional build steps.
23+
* **/Makefile**: We use make to wrap some Hugo commands and to add additional build steps.
2524
* **/tailwind.config.js**: This is the Tailwind CSS framwork's configuration file.
2625
* **/postcss.config.js**: Needed to make Tailwind statically accessible to the site.
2726

0 commit comments

Comments
 (0)