Skip to content

Commit

Permalink
DOC-642: fix 'make docs' to just build operator guide; fix links to n…
Browse files Browse the repository at this point in the history
…ew operator guide location
  • Loading branch information
trentm committed Jan 20, 2016
1 parent ec8d9f3 commit f1326f4
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/build
/docs/*.html
/docs/*.json
/docs/operator-guide/*.html
/docs/operator-guide/*.json
.DS_Store
8 changes: 6 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
#

#
# Copyright (c) 2014, Joyent, Inc.
# Copyright (c) 2016, Joyent, Inc.
#

#
# Files
#
DOC_FILES = $(shell find docs -name "*.md" | sed 's/docs\///;')

# Only care to build the operator guide for publishing directly out of
# this repo (to <http://joyent.github.io/manta/>). The other docs are
# pulled into apidocs.joyent.com.git for publishing there.
DOC_FILES = operator-guide/index.md

include ./tools/mk/Makefile.defs

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ the user documentation for details.

* To learn about installing and operating your own Manta deployment, see the
[Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md).
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md).

* To understand Manta's architecture, see
[Bringing Arbitrary Compute to Authoritative
Expand Down Expand Up @@ -100,7 +100,7 @@ to bootstrap a Manta installation.

Once you have SDC set up, follow the instructions in the
[Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md)
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md)
to deploy Manta. The easiest way to play around with your own Manta
installation is to first set up an SDC (cloud-on-a-laptop) installation in
VMware and then follow those instructions to deploy Manta on it.
Expand Down Expand Up @@ -188,7 +188,7 @@ Finally, scripts used to set up these component zones live in the
For more details on the architecture, including how these pieces actually fit
together, see "Architecture Basics" in the
[Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md).
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md).


## Deploying your own Manta Builds
Expand All @@ -205,7 +205,7 @@ of builds so that if something goes wrong, you know where to start looking. To
do this:

1. Complete the Manta deployment procedure from the [Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md).
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md).
1. Build a zone image for whatever zone you want to replace. See the
instructions for building [SmartDataCenter](https://github.com/joyent/sdc)
zone images using Mountain Gorilla. Manta zones work the same way. The
Expand All @@ -225,7 +225,7 @@ Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md).
sdc-imgadm import -m /var/tmp/my_manifest.json -f /var/tmp/my_image

1. Now you can use the normal Manta zone update procedure (from the [Manta
Operator's Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md).
Operator's Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md).
This involves saving the current configuration to a JSON
file using "manta-adm show -sj > config.json", updating the configuration
file, and then applying the changes with "manta-adm update < config.json".
Expand All @@ -241,7 +241,7 @@ manta-init but before deploying anything. Note that each subsequent
only used for the initial deployment anyway. The other option is to apply the
fully-manual install procedure from the
[Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md)
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md)
(i.e., instead of
using manta-deploy-coal or manta-deploy-lab) and use a custom "manta-adm"
configuration file in the first place. If this is an important use case, file
Expand All @@ -251,7 +251,7 @@ The above procedure works to update Manta *zones*, which are most of the
components above. The other two kinds of components are the *platform* and
*agents*. Both of these procedures are documented in the
[Manta Operator's
Guide](https://github.com/joyent/manta/blob/master/docs/manta-ops.md), and they work to deploy custom builds as well as the official Joyent
Guide](https://github.com/joyent/manta/blob/master/docs/operator-guide/index.md), and they work to deploy custom builds as well as the official Joyent
builds.


Expand Down
3 changes: 2 additions & 1 deletion tools/mk/Makefile.targ
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ DOC_MEDIA_FILES_BUILD := $(DOC_MEDIA_FILES:%=$(DOC_BUILD)/media/%)
# to get there.
#
.PHONY: docs
docs: \
docs:: \
$(DOC_FILES:%$(RESTDOWN_EXT)=$(DOC_BUILD)/%.html) \
$(DOC_FILES:%$(RESTDOWN_EXT)=$(DOC_BUILD)/%.json) \
$(DOC_MEDIA_FILES_BUILD)
Expand Down Expand Up @@ -294,6 +294,7 @@ CLEAN_FILES += \
$(DOC_MEDIA_FILES_BUILD): | $(DOC_MEDIA_DIRS_BUILD)

$(DOC_BUILD)/%: docs/% | $(DOC_BUILD)
$(MKDIR) $(shell dirname $@)
$(CP) $< $@

docs/%.json docs/%.html: docs/%$(RESTDOWN_EXT) | $(DOC_BUILD) $(RESTDOWN_EXEC) \
Expand Down

0 comments on commit f1326f4

Please sign in to comment.