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 1 commit
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
  •  
  •  
  •  
Prev Previous commit
Next Next commit
Riak KV 3.0.0 -> 3.0.4 (#111)
* 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 #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>
  • Loading branch information
5 people authored Jun 2, 2022
commit 47921c50744825cb5aed139a0bd6a90c5827206d
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
18 changes: 12 additions & 6 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 "guard-rake", "~>1.0.0"

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

# for the SFTP download metadata generator
gem "net-sftp"
#gem "json"
gem "uri"
279 changes: 150 additions & 129 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,129 +1,150 @@
[basho docs]: http://docs.basho.com/
[task list]: https://github.com/basho/private_basho_docs/issues/11
[middleman]: https://middlemanapp.com/
[rvm]: https://rvm.io/

# Basho's Documentation Generation

This repository contains all the bits and pieces, large and small required to
render and deploy Basho's documentation.

### http://docs.basho.com/

This is a Work In Progress!
Please let us know if you'd like to help out!

## Building The HTML Locally

1. Install [Hugo][hugo] by checking out [Hugo's Installing][installing hugo] page.

1. Clone the repository with:

```
git clone https://github.com/basho/basho_docs.git
cd basho_docs
```

1. Run Hugo with `hugo server` and wait a couple of seconds for the site to
build.

1. Play by visiting <http://localhost:1313>.

>**Heads-up**
>
> When running a local instance of the site, you can't navigate from the splash page (the first page when you navigate to localhost:1313) to the index page of KV, TS, or CS. You will need to manually enter the version in the address bar of your browser. So, for instance, http://localhost:1313/riak/kv/2.2.0/ rather than http://localhost:1313/riak/kv/latest/.

[hugo]: http://gohugo.io/
[installing hugo]: http://gohugo.io/overview/installing/
[homebrew]: http://brew.sh/

### No Really, _Go_ Play

<sub>See what we did there?</sub>

At this point, any changes you make to the markdown files in the `content/`
directory will be automatically detected and rendered live in your local browser.
Change some stuff! Have fun!

If you want to modify the [content templates][hugo content templates] that
define how each pages' HTML is generated, modifying the [Go Templates][hugo go template primer]
in `layouts/_default/` and the [partial templates][hugo partial templates] in
`layouts/partials/` will also be automatically detected and rendered live in your browser.

[hugo content templates]: https://gohugo.io/templates/content/
[hugo go template primer]: https://gohugo.io/templates/go-templates/
[hugo partial templates]: https://gohugo.io/templates/partials/
[hugo shortcodes]: https://gohugo.io/extras/shortcodes/

## Modifying the `.js` and `.css` Files

>**Note:** Generally, unless you're helping us out with a specific task or project that you've discussed with us, you should not be altering the .js or .css files in this repo.

If you want to mess with the scripts and CSS that this site uses, it's not
_quite_ as easy as modifying the HTML.

The scripts and CSS files used to render Hugo content are expected to live in
the `static/` directory. We use a lot of [Coffee Script][coffee] and [Sass][sass]
for our scripting and styling needs, and we convert those files to `.js` and
`.css` as a pre-render step. We put those `.coffee` and `.scss` files into the
`dynamic/` directory.

>**Note:** For files manually generated, place the source of the generation in
a directory parallel to the generated file(s), rooted in `public_src/`. If
possible, include a script to generate the output. For example, the uml
deployment diagram images in `static/images/redis/` were generated by the .uml
files in `public_src/images/redis/` via the script `gen_diagrams.sh` w/ the list
of source files for generation explicitly listed in `diagrams.lst`.

To convert the Coffee and Sass into `.js` and `.css` files, you'll need to:

1. **Install [RVM][rvm]** or equivalent.
You might need to restart your shell to get the `rvm` command to be recognized.
1. **Install Ruby.**
Use the following command: ``rvm install `cat .ruby-version` `` or manually
install the current version specified in our .ruby-version and Gemfile files.
1. **Install [Bundler]** with `gem install bundler`.
1. **Install the rest of the dependencies** with `bundle install`.
1. **Use [Rake] to do everything else**, like rebuild a copy of everything that
should live in `static/`. You can use `rake build` for that. For a more
debug-friendly version of everything, run `rake build:debug`.

In case you want any changes you make to `.coffee` and `.scss` files to be
automatically detected and rendered live in your browser, you can run
`rake watch`.

For a list of some of the useful commands, just run `rake`.

[coffee]: coffeescript.org
[sass]: http://sass-lang.com/
[rvm]: https://rvm.io/
[bundler]: http://bundler.io/
[rake]: http://docs.seattlerb.org/rake/

## Would You Like to Contribute?

Awesome! <sub>(We're assuming you said yes. Because you're reading this. And you're _awesome_.)</sub>

This repository operates just like any other open source repo, and only thrives
through the efforts of everyone who contributes to it. If you see something wrong,
something that could be improved, or something that's simply missing please
don't hesitate to:

* **Open Up a [New Issue]**
and let us know what you think should change.

* **[Find the File] You Want to Change**
and use GitHub's online editor to open a Pull Request right here.

* **[Fork] This Repository**
so you can make (and see) your changes locally.

Don't forget to check out our [Contributing Guidelines][contributing] so you
can read up on all our weird little quirks, like how we
[don't want you to use `<h1>` headers][contributing_headers].

[new issue]: https://github.com/basho/basho_docs/issues/new
[find the file]: https://github.com/basho/basho_docs/find/master
[fork]: https://github.com/basho/basho_docs/#fork-destination-box
[contributing]: CONTRIBUTING.md
[contributing_headers]: CONTRIBUTING.md
[basho docs]: http://docs.basho.com/
[task list]: https://github.com/basho/private_basho_docs/issues/11
[middleman]: https://middlemanapp.com/
[rvm]: https://rvm.io/

# Riak's Documentation Generation

This repository contains all the bits and pieces, large and small required to
render and deploy Basho's documentation.

### https://docs.riak.com/

This is updated for each new version of Riak once reviewed.

This is a Work In Progress!
Please let us know if you'd like to help out!

### https://www.tiot.jp/riak-docs/

This is updated for each new version of Riak as soon as written, and gets regular small updates.

### https://www.tiot.jp/riak-docs-beta/

This is updated for each new version of Riak as each doc section is updated, and often will be a WIP.

## Building The HTML Locally

We moved to a Docker image to build the docs to avoid the issues with getting the various versions of things to work together.

1. Install [Docker](https://docs.docker.com/engine/install/)

1. Clone the repository with:

```
git clone https://github.com/ti-tokyo/riak-docs-fork.git
cd riak-docs-fork
```

Or:

```
git clone https://github.com/basho/basho_docs.git
cd basho_docs
```

1. Build the Docker image:

```
./docker/docker-build-image.titokyo.sh
```

1. Run the docker image as a local server to test it all works:

```
docker-compose -f ./docker/docker-compose.localhost-preview.yaml up riakdocs
```

1. Play by visiting <http://localhost:1314/riak-docs/>.


### No Really, _Go_ Play

<sub>See what we did there?</sub>

At this point, any changes you make to the markdown files in the `content/`
directory will be automatically detected and rendered live in your local browser.
Change some stuff! Have fun!

If you want to modify the [content templates][hugo content templates] that
define how each pages' HTML is generated, modifying the [Go Templates][hugo go template primer]
in `layouts/_default/` and the [partial templates][hugo partial templates] in
`layouts/partials/` will also be automatically detected and rendered live in your browser.

[hugo content templates]: https://gohugo.io/templates/content/
[hugo go template primer]: https://gohugo.io/templates/go-templates/
[hugo partial templates]: https://gohugo.io/templates/partials/
[hugo shortcodes]: https://gohugo.io/extras/shortcodes/

## Modifying the `.js` and `.css` Files

>**Note:** Generally, unless you're helping us out with a specific task or project that you've discussed with us, you should not be altering the .js or .css files in this repo.

If you want to mess with the scripts and CSS that this site uses, it's not
_quite_ as easy as modifying the HTML.

The scripts and CSS files used to render Hugo content are expected to live in
the `static/` directory. We use a lot of [Coffee Script][coffee] and [Sass][sass]
for our scripting and styling needs, and we convert those files to `.js` and
`.css` as a pre-render step. We put those `.coffee` and `.scss` files into the
`dynamic/` directory.

>**Note:** For files manually generated, place the source of the generation in
a directory parallel to the generated file(s), rooted in `public_src/`. If
possible, include a script to generate the output. For example, the uml
deployment diagram images in `static/images/redis/` were generated by the .uml
files in `public_src/images/redis/` via the script `gen_diagrams.sh` w/ the list
of source files for generation explicitly listed in `diagrams.lst`.

To convert the Coffee and Sass into `.js` and `.css` files, you'll need to:

1. **Install [RVM][rvm]** or equivalent.
You might need to restart your shell to get the `rvm` command to be recognized.
1. **Install Ruby.**
Use the following command: ``rvm install `cat .ruby-version` `` or manually
install the current version specified in our .ruby-version and Gemfile files.
1. **Install [Bundler]** with `gem install bundler`.
1. **Install the rest of the dependencies** with `bundle install`.
1. **Use [Rake] to do everything else**, like rebuild a copy of everything that
should live in `static/`. You can use `rake build` for that. For a more
debug-friendly version of everything, run `rake build:debug`.

In case you want any changes you make to `.coffee` and `.scss` files to be
automatically detected and rendered live in your browser, you can run
`rake watch`.

For a list of some of the useful commands, just run `rake`.

[coffee]: coffeescript.org
[sass]: http://sass-lang.com/
[rvm]: https://rvm.io/
[bundler]: http://bundler.io/
[rake]: http://docs.seattlerb.org/rake/

## Would You Like to Contribute?

Awesome! <sub>(We're assuming you said yes. Because you're reading this. And you're _awesome_.)</sub>

This repository operates just like any other open source repo, and only thrives
through the efforts of everyone who contributes to it. If you see something wrong,
something that could be improved, or something that's simply missing please
don't hesitate to:

* **Open Up a [New Issue]**
and let us know what you think should change.

* **[Find the File] You Want to Change**
and use GitHub's online editor to open a Pull Request right here.

* **[Fork] This Repository**
so you can make (and see) your changes locally.

Don't forget to check out our [Contributing Guidelines][contributing] so you
can read up on all our weird little quirks, like how we
[don't want you to use `<h1>` headers][contributing_headers].

[new issue]: https://github.com/basho/basho_docs/issues/new
[find the file]: https://github.com/basho/basho_docs/find/master
[fork]: https://github.com/basho/basho_docs/#fork-destination-box
[contributing]: CONTRIBUTING.md
[contributing_headers]: CONTRIBUTING.md
23 changes: 12 additions & 11 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,16 @@
require_relative 'rake_libs/compile_js'
require_relative 'rake_libs/compile_css'
require_relative 'rake_libs/s3_deploy'
require_relative 'rake_libs/downloads_metadata_generator'
require_relative 'rake_libs/downloads_metadata_generator_sftp'
#require_relative 'rake_libs/downloads_metadata_generator'
require_relative 'rake_libs/projects_metadata_generator'

$css_source = "./dynamic/css"
$css_dest = "./static/css"
$js_source = "./dynamic/js"
$js_dest = "./static/js"
$cache_dir = "./dynamic/.cache"
$hugo_dest = "./public" # Should always be set to `publishdir` from config.yml
$hugo_dest = "./output" # Should always be set to `publishdir` from config.yml

### Rake directory definitions
directory "#{$js_dest}"
Expand All @@ -48,7 +49,6 @@ if Gem::Version.new(min_ruby_version) > Gem::Version.new(RUBY_VERSION)
"#{min_ruby_version}.\n")
end


# Check if Hugo is installed, and confirm it's up to date.
if (`which hugo`.empty?)
Kernel.abort("ERROR: No version of Hugo is installed.\n"\
Expand All @@ -73,7 +73,7 @@ end
# Default
Rake::TaskManager.record_task_metadata = true
task :default do
puts("Basho Documentation Generate System Usage:")
puts("Riak Documentation Generate System Usage:")
puts("")
Rake::application.options.show_tasks = :tasks # this solves sidewaysmilk problem
Rake::application.options.show_task_pattern = //
Expand Down Expand Up @@ -119,22 +119,23 @@ end
########
# Build
desc "Compile compressed JS and compressed CSS"
task :build => ['clean', 'build:js', 'build:css']
task :build => ['clean', 'build:css', 'build:js']
namespace :build do
task :js => ["#{$js_dest}", 'clean:js'] do compile_js(debug: false); end
task :css => ["#{$css_dest}", 'clean:css'] do compile_css(debug: false); end
task :js => ["#{$js_dest}", 'clean:js'] do compile_js(debug: false); end

################
# Build : Debug
desc "Compile human-readable JS and compile human-readable CSS"
task :debug => ["#{$js_dest}", "#{$css_dest}",
'build:debug:js', 'build:debug:css']
task :debug => ["#{$css_dest}", "#{$js_dest}",
'build:debug:css', 'build:debug:js']
namespace :debug do
desc "Compile human-readable CSS"
task :css => ["#{$css_dest}"] do compile_css(debug: true); end

desc "Compile human-readable JS"
task :js => ["#{$js_dest}"] do compile_js(debug: true); end

desc "Compile human-readable CSS"
task :css => ["#{$css_dest}"] do compile_css(debug: true); end
end
end

Expand Down Expand Up @@ -200,7 +201,7 @@ namespace :metadata do
task :all => ['metadata:generate_downloads', 'metadata:generate_projects']

desc "Generate package URI information"
task :generate_downloads do generate_downloads_metadata(); end
task :generate_downloads do generate_downloads_metadata_sftp(); end

desc "Generate JavaScript-readable project descriptions"
task :generate_projects do generate_projects_metadata(); end
Expand Down
Loading