I have moved two documents there so far:
- Release Instructions
- Publish Website
These two have been maintained internally before and were not publicly accessible.
We should keep the root directory clean and have there as little elements as possible.
As part of the move I also changed the default behavior of the scripts:
- If no argument is specified, it uses Docker to launch Jekyll.
- If you want to run it locally, you'll have to add "--docker=false" as argument.
- Adding an Update Stream document.
- Adding doc for MySQL server protocol.
- Adding a doc for Vitess Sequences.
- Doc on RBR.
- Removing obsolete replication doc.
publish site Tue Jan 24 13:13:41 PST 2017
This change adds full support for a Consul-based topology service.
See https://www.consul.io/ for more information.
- Adding consul server to bootstrap.sh for download.
- Adding client library to vendor.json.
- In unit tests, we start a dev Consul instance.
- Adding consul support in end-to-end tests.
Also running the test in travis.
- Updating topo doc.
- Adding Consul to 2.1 features.
The new etcd2 topology service is the new more consistent version of the
etcd topology. It has the following improvements:
- Uses the same file structure as zk2topo. It then also uses the generic
vtctld.Explorer as well.
- Uses the new etcd clientv3 library, with new key-value API and leases.
It is not backwards compatible with the old etcd topology.
- Uses a configurable toplevel directory for topology data in global and
local cells.
Vitess 2.1 will still include the old etcd topology client, but it will
be deprecated, and removed from Vitess 2.2. Use topo2topo binary to
upgrade, see documentation.
Implementation details:
- bootstrap.sh now downloads etcd.
- etcd is used in unit tests of the library, instead of using a mock.
- Fixing wrangler.InitTablet error return.
And adding -allow_update to test calls, so they work anyway.
- Running tabletmanager.py for zookeeper, zk2, etcd, etcd2 flavors.
- Ignoring the 'test' tag for vendored libraries. See:
https://github.com/kardianos/govendor#ignoring-build-tags-and-excluding-packages
- in end-to-end tests, restarting etcd to wipe it.
- publish web site.
I've created a new SVG file for this version because the page size is
different (32x32 instead of 320x320) and there is less space between the
logo and the page border (none from left to right to be precise).
Other changes:
- Delete the old logo.
- Make the icon a parameter in the template.
Our main (dark) color is taken from the "Indigo" material palette (500),
but the light background color is taken from the "Light Blue" palette.
This change fixes the inconsistency. Sections are now less baby blue :)
See: https://material.google.com/style/color.html#color-color-palette
I've also explicitly mentioned the used colors now e.g. Indigo 500.
I'm renaming the PivotSchemaChanges.md into SchemaSwap.md, modifying it to
describe the current schema swap process and reformatting to be easier to read
in an editor.
I'm also modifying the replication docs to mention schema swap instead of pivot,
and to correct a few not quite factually correct statements.
For example, http://vitess.io/doc/TopologyService/ was published but
never reachable from any navigation entry.
Stopping to publish /doc/ pages will also avoid duplication e.g.
- http://vitess.io/doc/Reparenting/ vs.
- http://vitess.io/user-guide/reparenting.html
Instead, to publish a page, an explicit *.md file must be created in /vitess.io and it must be linked in the navigation file vitess.io/_includes/left-nav-menu.html.
I did this for TopologyService.md and created vitess.io/user-guide/topology-service.md because it is a relevant page which is linked from several other pages.
This change also allows us to remove the script replace_doc_link.py. It
replaced github.com links (e.g.
https://github.com/youtube/vitess/blob/master/doc/TopologyService.md)
with a vitess.io link. Since we're always using absolute links anyway
(e.g. /user-guide/topology-service.html), this is no longer necessary.
By getting rid of the tool and the extra doc files (published under
_post), we can also avoid creating a copy when
running preview-site.sh. This way, Jekyll can watch the original folder
and automatically generate pages when something changes.
To make this work, I had to add the following symlinks:
vitess.io/_includes/doc
vitess.io/_includes/index.md
vitess.io/_includes/README.md
After this change, the following files in doc/ are not published on vitess.io:
- LifeOfAQuery.md
- Monitoring.md
- Production.md
- ReplicationStreamTiming.md
- TestingOnARamDisk.md
- TwoPhaseCommit.md
- V3HighLevelDesign.md
- V3VindexDesign.md
- Vision.md
- VTGateV3Features.md
Except for TestingOnARamDisk.md they also haven't been visible on vitess.io before. That's because no other page did link to them.
* Add Launching Vitess to vitess.io
* Fix markdown links.
* Fix Guides link
* split LaunchingVitess.md into subsections.
* rename Preparing for Production to Production Planning
* Turn TODOs into HTML comments
* Elaborate on cluster orchestration
* Use consistent capitalization of subheadings.
* Elaborate on application query patterns
* Elaborate on failover troubleshooting.
* Elaborate on additional MySQL parameters.
* Describe init_db.sql
* Document Orchestrator integration
Michael Berlin
wangyipei01
Sugu Sougoumarane
Alain Jobart
Pavel Ivanov
Anthony Yeh
Andy Diamondstein