Massive update to docs #2533
Draft
Massive update to docs #2533
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
* Added GSets * Updated notes on how to upgrade * Fixed a hiccup with reversed config file names * Added examples for Erlang and PHP client * Updated c# examples * Add updated NodeJS examples * Missed file plus Smarg edits * Gsets update * Upgrade instructions and resolving basho#2265 * Fixed version typo * Fixed an inherited grammatical error * Updated the install files to match the current status of the Riak community * Updated Basho reference * Fixed typo * Update gsets.md * Update content/riak/kv/2.2.6/setup/installing/rhel-centos.md * Update content/riak/kv/2.2.6/setup/installing/rhel-centos.md * Update gsets.md * Update gsets.md * Updates for Sets and GSets support. * GSets documentation updates. * Updated bucket and key for the Java and Ruby examples for consistency. * Fixes to known issues with the 2.2.6 docs. Does not fix gsets menu issue * Fixed strange path hiccup * Initial 2.9.0 commit with a little work done in content/riak/kv/2.9.0 * Updated relevant pages to 2.9.0 Updated references to 2.9.0, edited release notes to reflect 2.9.0 changes, added section on Transitioning from pre-2.9 releases. * WIP update * Revert "Updated bucket and key for the Java and Ruby examples for consistency." * Update release-notes.md * Updated backend.md to include leveled backend Updated documentation in backend.md to include information on the new leveled backend added in 2.9.0 * update leveled.md Fixed a couple of typos at the top of the document * updated leveled.md added weaknesses * update basic.md links to reflect riak.com Updated old basho.com links to reflect the new riak.com site. * updated old basho.com links to riak.com updated old basho.com links to riak.com for longevity. * updated documentation references Updated links to basho.com to new docs, added references to leveled backend where required. * Update basic.md * Update app-guide.md * Updating to 2.9.0 references Added new files for TicTac AAE. Added new references & configuration details * Updates upgrading docs Updates the upgrading docs with new guidance for 2.9 * Update TicTac-Active-anti-entropy.md Updated references for TicTac AAE * Update backend.md * Fixed a capitalisation error * Fixes requested by Nick * GSet updates for Ruby sample codes. * Update to updating objects - add curl Added curl examples in all the places found to be missing for updating objects in KV 2.2.6 docs. This can be copied directly to KV 2.9.0 docs without issue. * Added files for 2.9.1 Added files for 2.9.1, modified references for 2.9.1, added 2.9.1 release notes * Changed references to riak-admin and riak-repl Changed references to riak-admin and riak-repl as these are replaced with `riak admin` and `riak repl`. * Revert "Changed references to riak-admin and riak-repl" This reverts commit 084b320. * Added new versions to config.yaml Adds 2.2.6, 2.9.0, 2.9.1 to config.yaml, defines latest version in this branch as 2.9.1 * Edits to include links to the latest packages in 2.2.6/2.9.0 edits config.yaml to include new versions, updates downloads to include new versions & links therein * Modified erlang.md to reflect setting no longer included by default This closes issue #50 * Update to updating objects - add curl (#65) Added curl examples in all the places found to be missing for updating objects in KV 2.2.6 docs. This can be copied directly to KV 2.9.0 docs without issue. Co-authored-by: Nicholas Adams <nickadams_98@yahoo.com> Co-authored-by: Peter Clark <peter.clark@tiot.jp> * Creation of 2.9.2 branch & version changes. Creation of 2.9.2 branch & version changes. * Updated release notes for 2.9.2, added Node confirms details Updated release notes for 2.9.2, added Node confirms details * Revert "Updated release notes for 2.9.2, added Node confirms details" This reverts commit 05aaac8. * Copy from PJAC Performing a clobber to get the updates to 2.9.7 in place. Update includes all 2.x versions to 2.9.7, with updates from JOM for content. * Missing files from 2.9.7 update Found that next-gen-replication.md was missing from versions. Re-added. * Added missing latest to 2.9.7 * Remove KV 2.9.0 folder Leftover from when it was renamed to 2.9.0p5 * Fixed bad aliases for jmx.md * Updates to latest and restored two files Install instructions for solaris and smartos were missing. Versions are now deprecated, but instructions should be present for old versions with suitable note. Also fixed some /latest/ references. * Update releases notes, add NG rep configs (#76) Update releases notes, add NG rep configs * Added dockerfile and scripts * Added 2.9.8, 2.9.9 and 2.9.10 as copies of 2.9.7 * Fix strong-consistency find-replace errors * Removed */latest/* from 2.9.7->2.9.9 * Update config.yaml to have 2.9.8->2.9.10 * Fix 2.9.9/2.9.10 copy-paste error * Add Oracle OS, update metadata * Updated release notes for 2.9.7+ Bullet points added to all, and new content for 2.9.8+ * Removed PJAC debug * Fix for http:/localhost issue on downloads page * Remove debug code * Fix CRLF vs LF issue docker/run.sh was failing due to a CRLF line ending instead of LF. Also has updated CSS and JS files due to autogeneration. * How to use with docker (#85) (#86) Update readme with basic Docker instructions. Needs to be expanded on. * Make the leveled description render as a list (#88) The leveled markdown didn't have a blank line before the beginning of the list causing the list to render as a paragraph full of hyphens. Added a blank line. Beautiful rendering. * Change filename to match docs (#91) * Fix command error * Dev 3.0.1 pjac 3 (#105) Contains all the updates to get us to KV 3.0.1 * Creation of 2.9.2 branch & version changes. Creation of 2.9.2 branch & version changes. * Updated release notes for 2.9.2, added Node confirms details Updated release notes for 2.9.2, added Node confirms details * Revert "Updated release notes for 2.9.2, added Node confirms details" This reverts commit 05aaac8. * Copy from PJAC Performing a clobber to get the updates to 2.9.7 in place. Update includes all 2.x versions to 2.9.7, with updates from JOM for content. * Missing files from 2.9.7 update Found that next-gen-replication.md was missing from versions. Re-added. * Added missing latest to 2.9.7 * Remove KV 2.9.0 folder Leftover from when it was renamed to 2.9.0p5 * Fixed bad aliases for jmx.md * Updates to latest and restored two files Install instructions for solaris and smartos were missing. Versions are now deprecated, but instructions should be present for old versions with suitable note. Also fixed some /latest/ references. * Update releases notes, add NG rep configs (#76) Update releases notes, add NG rep configs * Added dockerfile and scripts * Added 2.9.8, 2.9.9 and 2.9.10 as copies of 2.9.7 * Fix strong-consistency find-replace errors * Removed */latest/* from 2.9.7->2.9.9 * Update config.yaml to have 2.9.8->2.9.10 * Fix 2.9.9/2.9.10 copy-paste error * Add Oracle OS, update metadata * Updated release notes for 2.9.7+ Bullet points added to all, and new content for 2.9.8+ * Removed PJAC debug * Fix for http:/localhost issue on downloads page * Remove debug code * Fix CRLF vs LF issue docker/run.sh was failing due to a CRLF line ending instead of LF. Also has updated CSS and JS files due to autogeneration. * How to use with docker (#85) (#86) Update readme with basic Docker instructions. Needs to be expanded on. * Make the leveled description render as a list (#88) The leveled markdown didn't have a blank line before the beginning of the list causing the list to render as a paragraph full of hyphens. Added a blank line. Beautiful rendering. * Change filename to match docs (#91) * Fix command error * Update docs for 3.0.1 (#96) * initial 3.0.1 branch creation initial 3.0.1 branch creation * Update release notes, config.yaml and index for 3.0.1 Update release notes, config.yaml and index for 3.0.1 * Updates riak-admin to riak admin Updates riak-admin to riak admin * Added docker files to 3.0.1 branch Added docker files to 3.0.1 branch * update config.yaml updating config to reflect past versions and correct LTS version, also fixes a doc link for archive * Initial commit * Multiple LTS support; hiding old series in menu * Made 'other' versions > current version visible * Update 3.0.1 to remove 2.9.7 metadata * Update files.tiot.jp URLs to point at right place * Update more install commands, and minor OSX * Added bullet points to 3.0.1 release notes Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Co-authored-by: Jay <jay@meangrape.com> * Dev 3.0.2 pjac (#106) * Fixes to < 3.0.2; Adds 3.0.2 * Adds 3.0.2 content * Adds KV 3.0.3 (#107) * Adds KV 3.0.4 (#108) * Dev 3.0.4 pjac (#109) * Adds KV 3.0.4 * Update project_descriptions.json * Fixes to 2.9.7 * Fixes to 2.9.8 * Fixes to 2.9.9 * Fixes to 2.9.10 * Remove 'latest' aliases from 2.9.10 * Remove 'latest' aliases from 2.9.10 * Minor 2.9.7 fix * Minor 2.9.7 fix * Minor 2.9.7 fix * Fixes to 2.9.10 * Fixes to 3.0.1 * Fixes to 3.0.2 * Fixes to 3.0.3 and 3.0.4 * Fixes the Release dates in release notes Fixes the Release dates in release notes - somehow got lost in changes. * Add 'latest' redirects * Fixed CSS image URLs * Add 'latest' for Riak CS * Removed old 'latest' from Riak TS * Fixed root latest for Riak CS * Add 'latest' for Riak TS * Fix intra-product menu on wide screens * Better LTS detection by series * Updates to index.md Updated index.md in versions 2.9.0p5 onwards, to reflect various points. * Revert "Merge branch 'dev' of https://github.com/TI-Tokyo/riak-docs-fork into dev" This reverts commit 130b136, reversing changes made to 9ba3e81. * More index fixes More index fixes * Revert "Revert "Merge branch 'dev' of https://github.com/TI-Tokyo/riak-docs-fork into dev"" This reverts commit b8b816d. * Updated index.md in 2.2.x versions for consistency Updated index.md in 2.2.x versions for consistency * Fixed a broken link on release notes Fixed a broken link on release notes * Made GitHub links configurable Co-authored-by: Bob-The-Marauder <nickadams_98@yahoo.com> Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Co-authored-by: Daniel B. Garcia <dandan02.0403@gmail.com> Co-authored-by: Jay <jay@meangrape.com>
Done to a) remove fake.txt, and b) to reset dev to master.
* Pretty OS version names taken from `data/os_metadata.yaml` * Configurable Contact Us URI in `config.yaml` * Removed `fake.txt` used for the HEAD reset in master
# Conflicts: # config.yaml # layouts/partials/content-navigation.html
* Updated file download data * More pretty names for OS versions * Show a configurable download root on Downloads
* Removed 'fake.txt' (#113) Done to a) remove fake.txt, and b) to reset dev to master. * Pretty OS version names and configurable Contact Us (#114) * Pretty OS version names taken from `data/os_metadata.yaml` * Configurable Contact Us URI in `config.yaml` * Removed `fake.txt` used for the HEAD reset in master * More pretty names and file store link on Downloads (#115) * Updated file download data * More pretty names for OS versions * Show a configurable download root on Downloads * Initial 3.0.6 update Initial 3.0.6 update * Update Index page Update Index page to reflect the correct support OS versions * Update release-notes.md Update release notes to reflect 3.0.6 changes * Updates Index.md for each versions supported OS Updates Index.md for each versions supported OS Co-authored-by: Peter Clark <peter.clark@tiot.jp> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp> Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>
Link to 3.0.7, should be 3.0.6
* Update for 3.0.9 Docs version (#127) * Removed 'fake.txt' (#113) Done to a) remove fake.txt, and b) to reset dev to master. * Pretty OS version names and configurable Contact Us (#114) * Pretty OS version names taken from `data/os_metadata.yaml` * Configurable Contact Us URI in `config.yaml` * Removed `fake.txt` used for the HEAD reset in master * More pretty names and file store link on Downloads (#115) * Updated file download data * More pretty names for OS versions * Show a configurable download root on Downloads * Initial 3.0.9 doc creation Initial 3.0.9 doc creation * Update Release notes for 3.0.9 Update Release notes for 3.0.9 * Update References and config.yaml for 3.0.9 Update References and config.yaml for 3.0.9, including the addition of the new default configuration for "worker_pool_size" * Fixes issues with riak-admin being used instead of riak admin Fixes issues with riak-admin being used instead of riak admin in versions 3.0.3 + Co-authored-by: Peter Clark <peter.clark@tiot.jp> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp> * Final 3.0.9 update (#139) * Removed 'fake.txt' (#113) Done to a) remove fake.txt, and b) to reset dev to master. * Pretty OS version names and configurable Contact Us (#114) * Pretty OS version names taken from `data/os_metadata.yaml` * Configurable Contact Us URI in `config.yaml` * Removed `fake.txt` used for the HEAD reset in master * More pretty names and file store link on Downloads (#115) * Updated file download data * More pretty names for OS versions * Show a configurable download root on Downloads * Initial 3.0.9 doc creation Initial 3.0.9 doc creation * Update Release notes for 3.0.9 Update Release notes for 3.0.9 * Update References and config.yaml for 3.0.9 Update References and config.yaml for 3.0.9, including the addition of the new default configuration for "worker_pool_size" * Fixes issues with riak-admin being used instead of riak admin Fixes issues with riak-admin being used instead of riak admin in versions 3.0.3 + Co-authored-by: Peter Clark <peter.clark@tiot.jp> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp> Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>
* Ideas for aae_fold documentation * Added filters section * Add support for riak attach code blocks * Add support for riak attach code blocks * Add support for riak attach code blocks * Updated menu order, split config from using * Split aae_fold into seperate files * Move TOC number to top of line * Fixed typos, errors and mistakes * Updated CSS * Updates * Split reap-tombs into seperate pages * Update root page title to Riak * Update AAE fold function list * Updated 2.9.4 * All value for segment filter * Add aae_fold to 2.9.7 * Add TicTacAAE to 2.9.0p5 * Add TicTacAAE to 2.9.1 * Add TicTacAAE to 2.9.2 * Update menu for 2.9.4 * Update menu for 2.9.7 * Add TicTacAAE to latest * chmod +w on docker build script * Fix riak attach links for 2.9.4 from aaefolds * Fix riak attach links for 2.9.7 for aaefolds * Add aaefolds to 2.9.8 * Add aaefolds to 2.9.9 * Add aaefolds to 2.9.10 * Set version history * Set version history * Add aaefolds to 3.0.1 * Set version history * Set version history * Add aaefolds to 3.0.2 * Set version history * Add aaefolds to 3.0.3 * Update aaefold's date filter to use readable dates * Add aaefolds to 3.0.4 * Add aaefolds to 3.0.6 * Add note to Configure TicTac AAE * Updated menu orders * Close table on Tictac AAE section * Remove link to NextGenRepl as only from 2.9.4 * Remove link to aaefold as not until 2.9.4 * Add config pages for AAE
* Update project descriptions metadata * Fix aae table ending * Add aaefold usage to 3.0.7, 3.0.8 and 3.0.9 * Updated downloads metadata
* Update for 3.0.9 Docs version (#127) * Removed 'fake.txt' (#113) Done to a) remove fake.txt, and b) to reset dev to master. * Pretty OS version names and configurable Contact Us (#114) * Pretty OS version names taken from `data/os_metadata.yaml` * Configurable Contact Us URI in `config.yaml` * Removed `fake.txt` used for the HEAD reset in master * More pretty names and file store link on Downloads (#115) * Updated file download data * More pretty names for OS versions * Show a configurable download root on Downloads * Initial 3.0.9 doc creation Initial 3.0.9 doc creation * Update Release notes for 3.0.9 Update Release notes for 3.0.9 * Update References and config.yaml for 3.0.9 Update References and config.yaml for 3.0.9, including the addition of the new default configuration for "worker_pool_size" * Fixes issues with riak-admin being used instead of riak admin Fixes issues with riak-admin being used instead of riak admin in versions 3.0.3 + Co-authored-by: Peter Clark <peter.clark@tiot.jp> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp> * Initial TS 3.0.0 * Update config.yaml with TS 3.0.0 * Updated metadata Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Co-authored-by: Andrei Zavada <andrei.zavada@tiot.jp>
* Markdown fixes * Update metadata * Undo bad link change
* Remove latest aliases from 3.0.0 * Remove latest aliases from 2.1.2 * Update download metadata 2023-08-16 * Add 3.0.1 * Update project descriptions * Make nav menu image link to version homepage * Added OTP version to CS 3.0.1 homepage * Added OTP version to CS 3.0.0. homepage * Hide titles for plaintext, text and log codeblocks * Fix headings * Hide codeblock title if blank * Fixed headings and tables * Formatting fixes * Moved Release notes and changes Downloads icon * Added the TOC back
* Remove latest aliases from 3.0.0 * Remove latest aliases from 2.1.2 * Update download metadata 2023-08-16 * Add 3.0.1 * Update project descriptions * Make nav menu image link to version homepage * Added OTP version to CS 3.0.1 homepage * Added OTP version to CS 3.0.0. homepage * Hide titles for plaintext, text and log codeblocks * Fix headings * Hide codeblock title if blank * Fixed headings and tables * Formatting fixes * Moved Release notes and changes Downloads icon * Added the TOC back
|
@nsaadouni Here's the PR you mentioned in this commit. |
* Add CS 3.0.1 docs (#221) (#223) * Remove latest aliases from 3.0.0 * Remove latest aliases from 2.1.2 * Update download metadata 2023-08-16 * Add 3.0.1 * Update project descriptions * Make nav menu image link to version homepage * Added OTP version to CS 3.0.1 homepage * Added OTP version to CS 3.0.0. homepage * Hide titles for plaintext, text and log codeblocks * Fix headings * Hide codeblock title if blank * Fixed headings and tables * Formatting fixes * Moved Release notes and changes Downloads icon * Added the TOC back * Add "project" to community files * Add search index and test cases * Added search indexes to all projects and versions * Remove dead 3rd party tracking code * Replace search results screen * Replace search box * Add project_name_html to JSON * Added basic lunr search * Fix frontmatter issue * Fix quote issue * Removed Google Tag Manager stubs * Search improvements * Fix link * Fix link * Fix link and add search_boost * Add sample keywords and search boosts * Add example deprecated content. * Add keywords and boosts to search indexes * Add header meta value * Better layout and boost support * Auto-hide menu and move CSS * Added keywords * Added score * Updated CSS/JS
This was missed in the PR from pjac-search on 2023-09-01 as the `dynamic/js/vendor` folder is in the git.ignore file.
* Update running-a-cluster.md * Update running-a-cluster.md
Added missing pages for 3.0.12+ Updated all to have correct URLs Updated 3.0.09-32.0.11 to have -r1 instead of -r0 Updated downloads template to show x86_64 and aarch64 available Updated 3.0.9+ to show Alpine Linux version and architecture
…236) * Fixes broken links as a result of riak-admin/riak admin changes Fixes broken links as a result of riak-admin/riak admin changes * leveled_ko/so context leveled_ko/so context, closes #234 * Removes errant search files Pesky search references that got missed previously have been eliminated. This fixes #225 Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
… remove basho support references (#240) (#241) * Resolves a broken link in a few pages after riak admin changes Resolves a broken link in a few pages after riak admin changes Also closes issue #220 * Changes to the upgrading checklist to remove references to basho support Changes to the upgrading checklist to remove references to Basho support and adds both community and TI Tokyo options. Also updates example emails in SI files from basho.com to dev.com Fixes issue #219 * Adds correct exampledomain usage Adds correct exampledomain usage Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
* Version History updates for V2.0.0 - V2.9.10 Version History updates for V2.0.0 - V2.9.10 * Removed some remnant search files Removed some remnant search files
* Fixes missing curl examples (#243) Fixes missing curl examples * missing curl example (#246) * Fixes missing curl examples Fixes missing curl examples * 2.9.0p5 curl examples 2.9.0p5 curl examples that vanished into space * 3.0.8 curl fix (#247) * Fixes missing curl examples Fixes missing curl examples * 2.9.0p5 curl examples 2.9.0p5 curl examples that vanished into space * 3.0.8 curl example 3.0.8 curl example --------- Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
* Add CS 3.0.1 docs (#221) * Remove latest aliases from 3.0.0 * Remove latest aliases from 2.1.2 * Update download metadata 2023-08-16 * Add 3.0.1 * Update project descriptions * Make nav menu image link to version homepage * Added OTP version to CS 3.0.1 homepage * Added OTP version to CS 3.0.0. homepage * Hide titles for plaintext, text and log codeblocks * Fix headings * Hide codeblock title if blank * Fixed headings and tables * Formatting fixes * Moved Release notes and changes Downloads icon * Added the TOC back * Added LUNR-based search (#226) * Add CS 3.0.1 docs (#221) (#223) * Remove latest aliases from 3.0.0 * Remove latest aliases from 2.1.2 * Update download metadata 2023-08-16 * Add 3.0.1 * Update project descriptions * Make nav menu image link to version homepage * Added OTP version to CS 3.0.1 homepage * Added OTP version to CS 3.0.0. homepage * Hide titles for plaintext, text and log codeblocks * Fix headings * Hide codeblock title if blank * Fixed headings and tables * Formatting fixes * Moved Release notes and changes Downloads icon * Added the TOC back * Add "project" to community files * Add search index and test cases * Added search indexes to all projects and versions * Remove dead 3rd party tracking code * Replace search results screen * Replace search box * Add project_name_html to JSON * Added basic lunr search * Fix frontmatter issue * Fix quote issue * Removed Google Tag Manager stubs * Search improvements * Fix link * Fix link * Fix link and add search_boost * Add sample keywords and search boosts * Add example deprecated content. * Add keywords and boosts to search indexes * Add header meta value * Better layout and boost support * Auto-hide menu and move CSS * Added keywords * Added score * Updated CSS/JS * Add LUNR 2.3.9 JS file This was missed in the PR from pjac-search on 2023-09-01 as the `dynamic/js/vendor` folder is in the git.ignore file. * Update running-a-cluster.md (#228) * Update running-a-cluster.md * Update running-a-cluster.md * Updated Alpine Linux instuctions (#237) Added missing pages for 3.0.12+ Updated all to have correct URLs Updated 3.0.09-32.0.11 to have -r1 instead of -r0 Updated downloads template to show x86_64 and aarch64 available Updated 3.0.9+ to show Alpine Linux version and architecture * Various issues with riak-admin changes and search files fixed (#235) (#236) * Fixes broken links as a result of riak-admin/riak admin changes Fixes broken links as a result of riak-admin/riak admin changes * leveled_ko/so context leveled_ko/so context, closes #234 * Removes errant search files Pesky search references that got missed previously have been eliminated. This fixes #225 Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> * Command Examples update (#230) (#239) Authored-by: James M <35449344+JMercerGit@users.noreply.github.com> Command output examples. * Fix for outdated references and changes to the upgrading checklist to remove basho support references (#240) (#241) * Resolves a broken link in a few pages after riak admin changes Resolves a broken link in a few pages after riak admin changes Also closes issue #220 * Changes to the upgrading checklist to remove references to basho support Changes to the upgrading checklist to remove references to Basho support and adds both community and TI Tokyo options. Also updates example emails in SI files from basho.com to dev.com Fixes issue #219 * Adds correct exampledomain usage Adds correct exampledomain usage Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> * Version History updates for V2.0.0 - V2.9.10 (#242) * Version History updates for V2.0.0 - V2.9.10 Version History updates for V2.0.0 - V2.9.10 * Removed some remnant search files Removed some remnant search files * Fixes missing curl examples (#243) (#245) * Fixes missing curl examples (#243) Fixes missing curl examples * missing curl example (#246) * Fixes missing curl examples Fixes missing curl examples * 2.9.0p5 curl examples 2.9.0p5 curl examples that vanished into space * 3.0.8 curl fix (#247) * Fixes missing curl examples Fixes missing curl examples * 2.9.0p5 curl examples 2.9.0p5 curl examples that vanished into space * 3.0.8 curl example 3.0.8 curl example --------- Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com> --------- Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
* Add sitemap defaults * Add sitemap to 2.0.0 * Add sitemap to 2.0.1 * Add sitemap to 2.0.2 * Add sitemap to 2.0.4 * Add sitemap to 2.0.5 * Add sitemap to 2.0.6 * Add sitemap to 2.0.7 * Add sitemap to 2.0.8 * Add sitemap to 2.0.9 * Add sitemap to 2.1.1 * Add sitemap to 2.1.3 * Add sitemap to 2.1.4 * Add sitemap to 2.2.0 * Add sitemap to 2.2.1 * Add sitemap to 2.2.2 * Add sitemap to 2.2.3 * Add sitemapt o 2.2.6 * Add sitemap to 2.9.0p5 * Wrong project_version * Add sitemap to 2.9.0p5 * Add sitemap to 2.9.1 * Add sitemap to 2.9.2 * Add sitemap to 2.9.4 * Add sitemap to 2.9.7 * Add sitemap to 2.9.8 * Add sitemap to 2.9.9 * Add sitemap to 2.9.10 * Add sitemap to 3.0.1 * Add sitemap to 3.0.2 * Add sitemap to 3.0.3 * Add sitemap to 3.0.4 * Add sitemap to 3.0.6 * Add sitemap to 3.0.7 * Add sitemap to 3.0.8 * Add sitemap to 3.0.9 * Add sitemap to 3.0.10 * Add sitemap to 3.0.11 * Add sitemap to 3.0.12 * Add sitemap 3.0.13 * Add sitemap to 3.0.14 * Add sitemap to 3.0.15 * Add sitemap to 3.0.16 * Add sitemap to 2.3.0 * Add sitemap to community * Add sitemap to KV latest * Add sitemap to CS 2.0.0 * Add sitemap to CS 2.0.1 * Add sitemap to CS latest * Add sitemap to CS 2.1.0 * Add sitemap to CS 2.1.1 * Add sitemap to 2.1.2 * Add sitemap to CS 3.0.0 * Add sitemap to CS 3.0.1 * Add sitemap to TS 1.0.0 * Add sitemap to TS 1.1.0 * Add sitemap to TS 1.2.0 * Add sitemap to TS 1.3.0 * Add sitemap to TS 1.3.1 * Add sitemap to TS 1.4.0 * Add sitemap to TS 1.5.0 * Add sitemap to TS 1.5.1 * Add sitemap to TS 1.5.2 * Add sitemap to TS 3.0.0 * Fix sitemap.priority/toc issue * Change sitemap.priority for top version to 0.9 * Change sitemap.priority for KV 3.0.16 to 0.9 * Add sitemap to community * Add sitemap.priority=0 to redirects * Remove empty files * Exclude search-index.json from sitemap * Remove redirects from sitemap
* Remove project-level search indexes from sitemap * Remove community search index form sitemap
* Fixed strong-consistency.md * Fixing broken riak-admin link Fixing broken riak-admin link * fixing rolling upgrades alias fixing rolling upgrades alias * Fixed broken release note link Fixed broken release note link * fixes broken alias' fixes broken alias' * adds some version numbers for pages * Revert "fixes broken alias'" This reverts commit 20aec56. * Adding version history Adding version history * More broken link fixes More broken link fixes * More broken links fixed More broken links fixed * Add ranges to version.in front matter * Update for ranges to version.in front matter * Update version.in value for non-contiguous ver * Fix typo * Adding Version IDs to relevant files * Corrected some version history Corrected some version history * Fixing some MD issues Fixing some MD issues * Removing remaining search files Removing remaining search files * Fixes missing version numbers Fixes missing version numbers * Fixes an incorrect version number Fixes an incorrect version number --------- Co-authored-by: James M <35449344+JMercerGit@users.noreply.github.com>
* Fix domain URLs with paths * Update baseurl with domains * Remove old script
* Creation of Oracle Linux Installation doc Creation of Oracle Linux Installation doc * Adds Version history to Oracle-Linux files Also adds missing file * Update menu order for installers --------- Co-authored-by: pjaclark <peter.clark@tiot.jp>
|
Amongst the other content fixes, I have now added an offline search function using Lunr JS. Using the same search box as before one can search the currently selected version of documentation. This means that if performing a search while browsing the KV 3.2.0 docs, it won't find irrelevant KV 2.0.1 content. This avoids the issue of search results finding The offline index is built by Hugo as part of the site build process. The new search function is done purely in the browser, so there is not depency on a 3rd party website to provide a search function. This makes the search function independent of the domain that Riak Docs is on. For those wishing to build the docs themselves, we have included a docker script that builds an image of Hugo that can then either serve the site directly via Hugo or be used to export all the necessary html files for the site to be hosted via Apache or nginx. Please see docker/deply.riak-info.docs.sh and docker/docker-compose.generate-docs-riak-info.yaml for an example deploy script. |
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.
Creating as a Draft PR so the below issues can be considered before merging.
Contains docs for all released versions of Riak KV since 2.0.0. New docs for Riak KV 2.2.6, 2.9.x, 3.0.x, and 3.2.x, Riak CS 2.1.2, 3.0.x, Riak TS 3.0.x. Includes a multitude of fixes to content, plus layout, render and markdown issues. A live version of this is at https://www.tiot.jp/riak-docs/.
Issues that should be looked at before merging:
config.yaml(currently TI Tokyo based for want of a better option):download_rootis tied to https://files.tiot.jp/riak/ as that is the only source of all compiled packages.The search issue is the only big item that needs looking at for deploying onto another server. This is why I haven't deployed a copy to https://docs.riak.info/ yet.
I suggest we make a set of config.yaml files (e.g.
config.riak-com.yamlandconfig.tiot-jp.yaml, for example) with specific changes for each. The README would then tell the user to copy one and (if wanted) make changes for their use.