Skip to content
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

Massive update to docs #2533

Draft
wants to merge 136 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
136 commits
Select commit Hold shift + click to select a range
423e60f
Resetting to Basho head
pjaclark Jun 2, 2022
47921c5
Riak KV 3.0.0 -> 3.0.4 (#111)
pjaclark Jun 2, 2022
ea688da
Removed 'fake.txt'
pjaclark Jun 2, 2022
2d318f2
Removed 'fake.txt' (#113)
pjaclark Jun 2, 2022
465bb83
Changed display name of OS versions on Downloads
pjaclark Jun 2, 2022
0127f14
Made Contact Us configurable
pjaclark Jun 2, 2022
d1ef1fb
Pretty OS version names and configurable Contact Us (#114)
pjaclark Jun 2, 2022
dc305bc
Fix for Contact Us url
pjaclark Jun 2, 2022
f1a2b2e
Merge remote-tracking branch 'origin/dev'
Jun 2, 2022
ad4d215
Updated file download data
pjaclark Jun 3, 2022
f81408b
More pretty names for OS versions
pjaclark Jun 4, 2022
64d0890
Show a configurable download root on Downloads
pjaclark Jun 4, 2022
629dab4
More pretty names and file store link on Downloads (#115)
pjaclark Jun 4, 2022
3143627
initial 3.0.6 update (#116) (#117)
pjaclark Jun 24, 2022
9f85fa4
3.0.7 doc creation and update (#122) (#124)
pjaclark Aug 5, 2022
fd8de13
Fix bad link
pjaclark Aug 5, 2022
8b5cfee
3.0.8 doc update (#125) (#126)
pjaclark Aug 5, 2022
b2f034b
Dev 3.0.9 (#143)
pjaclark Sep 30, 2022
e8e02c5
Dev pjac aaefold (#145)
pjaclark Nov 29, 2022
17c27ce
Dev pjac aaefold2 (#146)
pjaclark Nov 29, 2022
8734818
Dev ts 3.0.0 (#147)
pjaclark Nov 29, 2022
f811a23
Added Alpinhe Linux options
pjaclark Nov 29, 2022
8cf7fc9
Updated TS 3.0.0 supported OSs based on downloads
pjaclark Nov 29, 2022
a1893ee
Added OTP version to TS 3.0.0
pjaclark Nov 29, 2022
a3e6d3a
Removed link to Basho Academy
pjaclark Nov 29, 2022
55a85ce
Removed references to Basho Academy
pjaclark Nov 29, 2022
32b2da2
Add repair_keys_range aaefold function for 3.0.8+
pjaclark Nov 29, 2022
954686b
Changed the aaefold examples to use nicer dates.
pjaclark Nov 30, 2022
ec5dab5
Fix modified_filter for repair_keys_range function
pjaclark Nov 30, 2022
1d51d4c
Fix layout and add link
pjaclark Nov 30, 2022
b06793d
Fix layout and links
pjaclark Nov 30, 2022
edf8bbe
Add quick deploy scripts for TIOT
pjaclark Nov 30, 2022
cd9b36e
Fix incorrect erlang, specify riakattach
pjaclark Dec 2, 2022
60d287e
Fix typo
pjaclark Dec 2, 2022
08717de
Update code blocks erlang->riakattach, fix typo
pjaclark Dec 2, 2022
d86415d
Copy 2.1.2 -> 3.0.0
pjaclark Dec 2, 2022
97f878c
Update
pjaclark Dec 2, 2022
c685f82
3.0.10 updates (#151) (#153)
pjaclark Dec 7, 2022
3d22c66
3.0.11 release notes, file creation and version number changes (#152)…
pjaclark Dec 7, 2022
c58429f
Update project descriptions
pjaclark Dec 7, 2022
5f2e576
Add missing aaefold docs for 3.0.10
pjaclark Dec 7, 2022
3248589
Fix bad char at top of file
pjaclark Dec 7, 2022
b03fbcf
Updated instructions for Alpine Linux
pjaclark Dec 7, 2022
5f5605f
Add Alpine Linux to 3.0.11 and reorder menus
pjaclark Dec 7, 2022
818cf41
Updated downloads page to have Alpine Linux info.
pjaclark Dec 7, 2022
3c87106
Make alpine info on downloads consistant
pjaclark Dec 7, 2022
6548b60
Add alpine instructions to 3.0.9
pjaclark Dec 7, 2022
f9213ec
Update alpine instructions
pjaclark Dec 7, 2022
e1505fa
Update 3.0.9 instructions to use the testing repo
pjaclark Dec 7, 2022
cc524ce
Fix numbering in alpine 3.0.9
pjaclark Dec 7, 2022
9324719
Removing superflous 3.0.9 alpine instruction
pjaclark Dec 7, 2022
9e87161
Point GitHub to dev branch
pjaclark Dec 7, 2022
db2ab6b
Update alpine install instructions
pjaclark Dec 7, 2022
5fbc1e0
Fix typo
pjaclark Dec 7, 2022
953fa5e
Make alpine install instuctions since 3.0.9
pjaclark Dec 7, 2022
c9af483
Added latest for aaefolds
pjaclark Dec 7, 2022
3c948b8
Merge branch 'master' into dev
pjaclark Dec 9, 2022
a5e1240
Add docs.riak.info docker compose file
pjaclark Dec 9, 2022
c6b0fcd
Dev 3.0.12 (#163)
pjaclark Jan 20, 2023
6ac0a1a
Dev 3.0.12 (#171)
pjaclark Jan 20, 2023
2b0c8d9
Merge branch 'basho:master' into dev
pjaclark Jan 20, 2023
9998aff
3.2.0 updates (#177) (#179)
pjaclark Feb 9, 2023
1f6061d
Fix to date (#175)
pjaclark Feb 9, 2023
60299c9
Fix typo (#174)
pjaclark Feb 9, 2023
0c48f67
Key changes for Riak CS 3.0.0 (#185)
Bob-The-Marauder May 5, 2023
1a63c3d
Merge branch 'dev' into dev-cs-3.0.0
pjaclark May 5, 2023
f5b316a
Dev cs 3.0.0 (#186)
pjaclark May 5, 2023
5f3f987
Updated to dockers files and metadata.
pjaclark May 11, 2023
641a2ae
Fix URL errors
pjaclark May 11, 2023
5e818bb
URl fix
pjaclark May 11, 2023
b5cebf9
Fix bad links to KV latest
pjaclark May 11, 2023
65c15e9
Add markdownlint to allow acceptable errors
pjaclark May 11, 2023
cf6f471
Fix markdown
pjaclark May 11, 2023
9afc4c1
Fixes for Riak search across verions (#187)
JMercerGit May 12, 2023
92869d1
Revert "Fixes for Riak search across verions (#187)" (#188)
pjaclark May 12, 2023
6a8cafd
Merge branch 'dev' of github.com:Ti-Tokyo/riak-docs-fork into dev
pjaclark May 12, 2023
bf5c24c
Search fixes (#189)
JMercerGit May 12, 2023
633e64d
Merge branch 'dev' of github.com:Ti-Tokyo/riak-docs-fork into dev
pjaclark May 12, 2023
2aef7f9
Mark 2.x search files as only in 2.x (#193)
pjaclark May 12, 2023
ec22fbc
Updating index.md (#191)
JMercerGit May 12, 2023
1fcd9d6
Fix broken links and update old version references (#190)
Bob-The-Marauder May 12, 2023
00578ae
Updates to install doc (#195)
Bob-The-Marauder May 12, 2023
d2532de
Merge branch 'dev' into dev-cs-3.0.0
pjaclark May 12, 2023
49adbe2
Update installing.md
pjaclark May 12, 2023
aac2290
Update installing.md
pjaclark May 12, 2023
2e39fc9
Update installing.md
pjaclark May 12, 2023
e605f53
Update installing.md
pjaclark May 12, 2023
6685b83
Update installing.md
pjaclark May 12, 2023
3c47eb2
Dev cs 3.0.0 (#194)
pjaclark May 12, 2023
85bb815
Fix bad Stanchion file links
pjaclark May 12, 2023
8121da2
Update installing.md
pjaclark May 12, 2023
d6b1d52
Update installing.md
pjaclark May 12, 2023
db1254c
Update installing.md
pjaclark May 12, 2023
b8ba524
Set KV 3.2 as LTS and hide 2.2 in menu
pjaclark May 14, 2023
5418825
Remove markdown issues (#197)
pjaclark May 19, 2023
43ce02c
Add aae_fold function erase_keys (#201)
pjaclark Jun 9, 2023
82b3852
Update installing.md (#203)
Bob-The-Marauder Jun 13, 2023
0fc29fc
Merge branch 'dev' into dev-cs-3.0.0
pjaclark Jun 14, 2023
d438b83
Update installing.md
pjaclark Jun 14, 2023
07fb81d
Merge pull request #204 from TI-Tokyo/dev-cs-3.0.0
Bob-The-Marauder Jun 14, 2023
077aad9
Add erase_keys to 2.9.4+ (#205)
pjaclark Jun 16, 2023
50e05eb
Pjac erase keys historic (#206)
pjaclark Jun 16, 2023
375e716
version updates and other fixes (#202) (#207)
pjaclark Jun 16, 2023
95d9316
config fixes (#209)
JMercerGit Jun 16, 2023
c806d89
Updated downloads and projects metadata files
pjaclark Jun 16, 2023
01708d6
Add aae_fold erase keys to 3.0.13 to 3.0.15 (#210)
pjaclark Jun 16, 2023
844552a
Add erase_keys and fix some markdown lint (#211)
pjaclark Jun 16, 2023
83e9ce9
Re-order menus for Data Types (#213)
pjaclark Jun 30, 2023
2e5ac25
Menu order change (#214)
pjaclark Jun 30, 2023
be88182
Initial 3.0.16 creation (#212) (#215)
pjaclark Jul 6, 2023
dba0b4f
Fix data type list order for 3.0.16
pjaclark Jul 6, 2023
eee08d8
Markdown lint fixes and metadata update (#216)
pjaclark Jul 6, 2023
444c0c0
Add CS 3.0.1 docs (#221)
pjaclark Aug 18, 2023
8d694ce
Add CS 3.0.1 docs (#221) (#223)
pjaclark Aug 23, 2023
d2c0ca0
Added LUNR-based search (#226)
pjaclark Sep 1, 2023
b8d7618
Add LUNR 2.3.9 JS file
pjaclark Sep 1, 2023
27b059f
Update running-a-cluster.md (#228)
pjaclark Nov 10, 2023
c6f3359
Updated Alpine Linux instuctions (#237)
pjaclark Nov 10, 2023
0a4ba31
Merge branch 'master' into dev
pjaclark Nov 10, 2023
237bc22
Various issues with riak-admin changes and search files fixed (#235) …
pjaclark Nov 10, 2023
ed3008e
Command Examples update (#230) (#239)
pjaclark Nov 10, 2023
49654ec
Fix for outdated references and changes to the upgrading checklist to…
pjaclark Nov 17, 2023
855b644
Version History updates for V2.0.0 - V2.9.10 (#242)
JMercerGit Nov 23, 2023
962c547
Fixes missing curl examples (#243) (#245)
pjaclark Nov 24, 2023
9dead9f
Merge dev into master (#238)
pjaclark Nov 24, 2023
7455c4d
Add sitemap support (#251)
pjaclark Nov 29, 2023
73c1ee4
Remove general search indexes from sitemap (#252)
pjaclark Nov 29, 2023
18a5905
Fixes various 404 page issues (#249)
pjaclark Dec 8, 2023
214eee2
Fix doc generation for non-root paths (#256)
pjaclark Dec 11, 2023
b61ccd0
Set canonical to be latest version instead of "latest" (#257)
pjaclark Dec 11, 2023
79d6b25
Creation of Oracle Linux Installation doc (#258)
JMercerGit Dec 15, 2023
1b0bf32
Merge changes between dev and master
pjaclark Dec 15, 2023
e35cca3
Remove duplicate (#260)
pjaclark Dec 15, 2023
8a47bdd
Remove duplicate (#261)
pjaclark Dec 22, 2023
f20d6f8
Fix merge conflicts
pjaclark Dec 22, 2023
ff6f648
Update Dockerfile
pjaclark Mar 18, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Gemfile.lock

# Statically generated HTML
public/**
output/**

# Files maintained from the middleman build
archived_docs.basho.com.tar.bz2
Expand Down
13 changes: 13 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"MD001": false,
"MD010": {
"ignore_code_languages": ["go"]
},
"MD013": false,
"MD024": false,
"MD026": false,
"MD033": false,
"MD049": false,
"MD051": false,
"MD053": false
}
40 changes: 23 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ yet, though, and we're not sure when that might happen. For now, please be
careful when writing new pages or modifying the front matter/location of
existing ones.


#### Primary Content Pages

This is the default layout for pages. Anything that is not the splash page
Expand Down Expand Up @@ -57,28 +56,28 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional
---
```

1. The Page Title is the title of the page, in the context of both the
1. The Page Title is the title of the page, in the context of both the
<head><title> element and as rendered on the page.

The rendered title will be placed above the primary content (above the text
that makes up the markdown document) as the only <h1> element on the
page. If the Title Super-Text (1.b, `title_supertext`) is present, it will
be rendered above the Page Title, using a slightly reduced font.

2. The Description should be a quick, single-sentence summary of the page.
2. The Description should be a quick, single-sentence summary of the page.

It will be used in a `<meta name="description">` tag for rich content
summaries and potentially as the title text that appears when hovering over
menu item elements.

3. The Project Designation that this page is associated with.
3. The Project Designation that this page is associated with.

In the case of pages located under riak/kv/ and riak/ts, the designation
will use underscores, ex. `riak_kv`, and `riak_ts`.

4. The Project Version that this page is associated with.
4. The Project Version that this page is associated with.

5. "Hugo has a simple yet powerful menu system that permits content to be
5. "Hugo has a simple yet powerful menu system that permits content to be
placed in menus with a good degree of control without a lot of work."

https://gohugo.io/extras/menus
Expand Down Expand Up @@ -132,15 +131,15 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional

<!-- TODO: Build and link to a reference page that shows off all icons -->

6. Whether or not a Table of Contents should be rendered.
6. Whether or not a Table of Contents should be rendered.

Defaults to `true`.

7. Whether or not the 'Enterprise Only Content' flag should be rendered.
7. Whether or not the 'Enterprise Only Content' flag should be rendered.

Defaults to `false`.

8. The `version_history` element is optional, but should be included on all
8. The `version_history` element is optional, but should be included on all
pages that do not exist, or do not exist in the same location, in every
version of a given project.

Expand All @@ -159,6 +158,15 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional
in: "1.2.0-2.99.99"
```

For pages that apply to non-contiguous versions, specify `in` as an array:

```
version_history:
in:
- "1.2.0-2.99.99"
- "3.2.0+"
```

> For more information regarding Version Ranges, please see the
> `ParseRange` function in js/tools/sem_ver.coffee.

Expand Down Expand Up @@ -209,7 +217,7 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional
> - ["<1.4.0", "using/arithmetic-operations"]
> ```

9. The canonical URI for the page
9. The canonical URI for the page

If this element is excluded, the canonical URI will default to
`${project_path}/latest/${project_relative_path}`. **If this is
Expand All @@ -230,7 +238,6 @@ canonical_link: "https://docs.basho.com/. . ." # 10 -- Conditional
We primarily leverage aliases to redirect from archived content to more
current pages.


#### Downloads Pages

For Downloads pages -- those that present automatically generated links to
Expand Down Expand Up @@ -269,7 +276,6 @@ listed_projects: # 2
This does not need to match any other data, and as such should be
descriptive, rather than technical.


#### Community Pages

Pages in the Community section of content are not versioned in the same way as
Expand Down Expand Up @@ -298,24 +304,24 @@ canonical_link: "https://docs.basho.com/. . ." # 2 -- OPTIONAL
---
```

1. The `menu` map of a Community page should be treated similarly to the `menu`
1. The `menu` map of a Community page should be treated similarly to the `menu`
of a primary content page, save for menu name. Because there is no
`project_version` in the Community front matter, the name of the menu **must
be** `community`.

2. Default canonical links for Community pages are slightly different from and
2. Default canonical links for Community pages are slightly different from and
simpler than primary content pages; `community/${project_relative_path}`.
Again, this element is entirely optional.


## Problematic Markdown (and Workarounds)

#### Markdown Tables

<!--
Added 2016/05/10 after Hipchat conversation between LR and CV - This workaround will ideally
be removed if/when the Hugo MD renderer addresses this precedence issue. -cv
-->
**Problem**: Inserting an element with a `|` character can cause a table to render incorrectly.
**Solution**: Replace the `|` with the HTML entity `&#124;`.
**Problem**: Inserting an element with a `|` character can cause a table to render incorrectly.
**Solution**: Replace the `|` with the HTML entity `&#124;`.
**Note**: This workaround will not work when the `|` is inside of backticks. In
that case, use the Divides character ("∣"—U+2223) in place of those instances of the pipe character.
26 changes: 16 additions & 10 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
source "https://rubygems.org"
ruby "2.2.5"
ruby ">2.2.5"

#TOOD: This file is now out of date.
# We need to walk the gems and make sure that,
Expand All @@ -11,16 +11,22 @@ gem "autoprefixer-rails", "~>6.3.6"
gem "sprockets", "~>3.7"
gem "coffee-script", "~>2.4.1"
gem "uglifier", "~>3.0.0"
gem "therubyracer"
gem "mini_racer" # included via the docker image

gem "aws-sdk", "~> 2.4.3"
gem "aws-s3", "~> 0.6.3"
gem "simple-cloudfront-invalidator", "~>1.1.0"
gem "progressbar", "~> 1.8.0"
# deprecated as new files are on files.tiot.jp
#gem "aws-sdk", "~> 2.4.3"
#gem "aws-s3", "~> 0.6.3"
#gem "simple-cloudfront-invalidator", "~>1.1.0"
#gem "progressbar", "~> 1.8.0"

gem "rake", "~>11.2.2"
gem "guard", "~>2.14.0"
gem "rake", "~>13.0.6"
gem "guard", "~>2.18.0"
gem "guard-rake", "~>1.0.0"

gem "pry", "~>0.10.3"
gem "pry-byebug", "~>3.4.0"
gem "pry", "~>0.14.2"
gem "pry-byebug", "~>3.10.1"

# for the SFTP download metadata generator
gem "net-sftp"
#gem "json"
gem "uri"
Loading