search

TritonDataCenter / sdc-docker

Docker Engine for Triton
Mozilla Public License 2.0
183 stars 49 forks source link

Documentation reorg #29

Closed misterbisson closed 9 years ago

misterbisson commented 9 years ago

This PR represents my proposed outline and some of the content for SDC Docker (and a pattern I think will serve us well elsewhere).

Outline and plan

Main repo README.md

Ideally this text will eventually be targeted to developers, but also include links to the API reference and operator's guide on joyent.com sites.

API reference

The contents of this section describe the API (via the Docker CLI commands, for now), divergence in behavior compared to Docker Inc's implementation, as well as generic connection and troubleshooting information (nothing specific or limited to JPC).

This content will live here and be published at https://apidocs.joyent.com/docker/

Operator's guide

Information on how to install, configure, and manage SDC Docker in Triton, as used by Triton operators. This should also include basic information about how to use the service, though that's addressed mostly by pointing to the API docs. Some of this content now exists in the main README.md and should move here, in my plan.

This content should likely move to https://github.com/joyent/sdc/tree/master/docs, though I've left that for a future task. The combined docs in https://github.com/joyent/sdc would eventually become the authority for content published at https://docs.joyent.com/sdc7 (or whatever future URL that becomes). Resolving that will include merging this, the content in https://github.com/joyent/sdc/tree/master/docs, and in the other documentation repo.

Development guide

Information for developers, including steps to build project and documents referenced while designing it. This would be in addition to and expanding on the content in the main README.md.

trentm commented 9 years ago

Generally fine by me. Still not sure about 'api/' as the dir given that the docker CLI is way more relevant than the particulars of the Docker Remote API. I'm not religious on it.

dwlf commented 9 years ago

I haven't looked at this in detail, but a search for "sudo" suggests there might be a few more edits needed.

Is there a file that explains our strategy for using docker/docker content? approach, if any, to upstream/sync? Are we using the same license on our documentation as docker/docker?

Aside, I loath sentence case for headings.

trentm commented 9 years ago

@misterbisson that was me cherry-picking and squashing your changes onto #master. :) See DOCKER-369.