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

Go back to small /edge #2736

Merged
merged 5 commits into from
Apr 14, 2017
Merged

Go back to small /edge #2736

merged 5 commits into from
Apr 14, 2017

Conversation

mdlinville
Copy link

Proposed changes

Rather than having two whole versions of the site, one edge and one stable, just have the one version, but have a /edge/ subdirectory with its own index, CLI reference stubs, and API reference. In the Edge CLI reference stubs, have an admonition that they are edge and give a link back to the non-Edge one.

A few new files are fetched in the Dockerfile and put into the right places in /edge/.

So there is an entry for /edge/ in the left-hand TOC, and there are links to the edge CLI and API refs near the stable ones in the Reference tab.

This PR also pulls out the no-longer-used glossary.md from the Dockerfile.

I retained the Try the Edge docs link in the tab bar, for visibility.

Netlify will get you some of the way there, but to really test, you need to build the Dockerfile and run locally.

@mdlinville
Copy link
Author

Fixes #2720

Copy link

@johndmulhausen johndmulhausen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove the baby Developer Guide section for now; this I think should specifically be a guide to "programming with Docker." That is, setting up the environment, using official libraries for their langauges, using IDE integration details from labs, following pipeline hints from Success (https://success.docker.com/Architecture/Docker_Reference_Architecture%3A_Development_Pipeline_Best_Practices_Using_Docker_EE), any other thing that shows how to work with the platform as a dev. I think what's here now, though it may be of interest to developers, is a little jarring and confusing, because it just links right into Engine API docs. They might not even need to use the Engine API, you know?

Other than that this PR is awesome.

@mdlinville
Copy link
Author

OK, I popped off the top commit. Merge at will.

@johndmulhausen
Copy link

Thanks, @mstanleyjones :)

@johndmulhausen johndmulhausen merged commit 10be60a into docker:master Apr 14, 2017
@johndmulhausen johndmulhausen self-assigned this Apr 14, 2017
@mdlinville mdlinville deleted the small_edge branch April 15, 2017 00:44
johndmulhausen pushed a commit that referenced this pull request Apr 18, 2017
* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API
johndmulhausen added a commit that referenced this pull request Apr 18, 2017
* Create index.md

* Create part2.md

* Create part3.md

* Create part4.md

* Create part5.md

* Rewrite step 2

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update index.md

* Rewrite of part 3

* Tabs-based swarm instructions, pass 1

* Rewrite of parts 3 and 4, tabs implementation

* Navigation, rewrites, part 4 completion

* Part 5 w/Redis

* Part 5, compelte Redis, rename part 6

* TOC/redirect implementation

* Update part6.md

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix overview

* Label diagrams

* Fix button

* Fix link to where Stacks are covered

* Fix typo

* s/file/directory

* Reformat paragraph

* Shorten tabs

* Typos

* Release DTR 2.2.4, 2.1.6

* Go back to small /edge (#2736)

* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API

* Fix a few 404s (#2785)

* Fix typo

* Propose use of another word (#2791)

I think that interested is better than invested, in this case.

* Update secrets.md (#2780)

remove correct secret

* Change mount syntax on windows from //c/ to c:\ (#2761)

LGTM

* Update hackathon.md (#2773)

* nodes.md grammar correction (#2802)

* Grammar and formatting check (#2797)

* Wrong article

If the first word starts with a vowel sound you use an. If the first word has a consonant sound use a.

* Making the text bold

Removing backticks because probably the text needs to be bold and not marked as code.

* Update overview.md (#2805)

It should say 'predecessors', not 'successors'. Otherwise the sentence and the subsequent example don't make sense.

* shrink some big images (#2798)

Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>

* #2627 (#2804)

- Fix right sidebar overflow on rescale

* Update hackathon.md

* change pre-build to pre_build to remove confusion (#2813)

* change pre-build to pre_build to remove confusion

* clarify that pre_build hook refers to a file

* Update TOC to sentence case (#2790)

* add more info about DTR on the overview page (#2794)

fix #1904

* Update glossary.yaml (#2807)

Fix #2575.

* fix imports since docker api pkg migration, fix example repository name to be canonical (#2806)

* tweak: code format for filename (#2829)

* tweak: code format for filename

slight reword, so as to avoid confusion w/filename

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* small changes just to kick build again

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Update hackathon.md

* fix broken links (#2808)

* fix broken link (#2809)

* [CONTRIBUTING] update broken link (#2826)

* [Debian] add gnupg2 requirement for stretch (#2823)

* TOC/redirect implementation

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix bad merge

* Metadata, formatting

* Front page formatting, link instrumentation
joeuo pushed a commit to joeuo/docker.github.io that referenced this pull request Apr 18, 2017
* Create index.md

* Create part2.md

* Create part3.md

* Create part4.md

* Create part5.md

* Rewrite step 2

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update index.md

* Rewrite of part 3

* Tabs-based swarm instructions, pass 1

* Rewrite of parts 3 and 4, tabs implementation

* Navigation, rewrites, part 4 completion

* Part 5 w/Redis

* Part 5, compelte Redis, rename part 6

* TOC/redirect implementation

* Update part6.md

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix overview

* Label diagrams

* Fix button

* Fix link to where Stacks are covered

* Fix typo

* s/file/directory

* Reformat paragraph

* Shorten tabs

* Typos

* Release DTR 2.2.4, 2.1.6

* Go back to small /edge (docker#2736)

* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API

* Fix a few 404s (docker#2785)

* Fix typo

* Propose use of another word (docker#2791)

I think that interested is better than invested, in this case.

* Update secrets.md (docker#2780)

remove correct secret

* Change mount syntax on windows from //c/ to c:\ (docker#2761)

LGTM

* Update hackathon.md (docker#2773)

* nodes.md grammar correction (docker#2802)

* Grammar and formatting check (docker#2797)

* Wrong article

If the first word starts with a vowel sound you use an. If the first word has a consonant sound use a.

* Making the text bold

Removing backticks because probably the text needs to be bold and not marked as code.

* Update overview.md (docker#2805)

It should say 'predecessors', not 'successors'. Otherwise the sentence and the subsequent example don't make sense.

* shrink some big images (docker#2798)

Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>

* docker#2627 (docker#2804)

- Fix right sidebar overflow on rescale

* Update hackathon.md

* change pre-build to pre_build to remove confusion (docker#2813)

* change pre-build to pre_build to remove confusion

* clarify that pre_build hook refers to a file

* Update TOC to sentence case (docker#2790)

* add more info about DTR on the overview page (docker#2794)

fix docker#1904

* Update glossary.yaml (docker#2807)

Fix docker#2575.

* fix imports since docker api pkg migration, fix example repository name to be canonical (docker#2806)

* tweak: code format for filename (docker#2829)

* tweak: code format for filename

slight reword, so as to avoid confusion w/filename

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* small changes just to kick build again

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Update hackathon.md

* fix broken links (docker#2808)

* fix broken link (docker#2809)

* [CONTRIBUTING] update broken link (docker#2826)

* [Debian] add gnupg2 requirement for stretch (docker#2823)

* TOC/redirect implementation

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix bad merge

* Metadata, formatting

* Front page formatting, link instrumentation
joeuo pushed a commit to joeuo/docker.github.io that referenced this pull request Apr 18, 2017
* Create index.md

* Create part2.md

* Create part3.md

* Create part4.md

* Create part5.md

* Rewrite step 2

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update part2.md

* Update index.md

* Rewrite of part 3

* Tabs-based swarm instructions, pass 1

* Rewrite of parts 3 and 4, tabs implementation

* Navigation, rewrites, part 4 completion

* Part 5 w/Redis

* Part 5, compelte Redis, rename part 6

* TOC/redirect implementation

* Update part6.md

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix overview

* Label diagrams

* Fix button

* Fix link to where Stacks are covered

* Fix typo

* s/file/directory

* Reformat paragraph

* Shorten tabs

* Typos

* Release DTR 2.2.4, 2.1.6

* Go back to small /edge (docker#2736)

* Go back to small /edge

* Update site front page

Add info about Editions
Reorganize components
Update headings

* Move logic of fetching content to a script

* Add v1.28 API

* Add info about versioned API

* Fix a few 404s (docker#2785)

* Fix typo

* Propose use of another word (docker#2791)

I think that interested is better than invested, in this case.

* Update secrets.md (docker#2780)

remove correct secret

* Change mount syntax on windows from //c/ to c:\ (docker#2761)

LGTM

* Update hackathon.md (docker#2773)

* nodes.md grammar correction (docker#2802)

* Grammar and formatting check (docker#2797)

* Wrong article

If the first word starts with a vowel sound you use an. If the first word has a consonant sound use a.

* Making the text bold

Removing backticks because probably the text needs to be bold and not marked as code.

* Update overview.md (docker#2805)

It should say 'predecessors', not 'successors'. Otherwise the sentence and the subsequent example don't make sense.

* shrink some big images (docker#2798)

Signed-off-by: Cristian Staretu <cristian.staretu@gmail.com>

* docker#2627 (docker#2804)

- Fix right sidebar overflow on rescale

* Update hackathon.md

* change pre-build to pre_build to remove confusion (docker#2813)

* change pre-build to pre_build to remove confusion

* clarify that pre_build hook refers to a file

* Update TOC to sentence case (docker#2790)

* add more info about DTR on the overview page (docker#2794)

fix docker#1904

* Update glossary.yaml (docker#2807)

Fix docker#2575.

* fix imports since docker api pkg migration, fix example repository name to be canonical (docker#2806)

* tweak: code format for filename (docker#2829)

* tweak: code format for filename

slight reword, so as to avoid confusion w/filename

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* small changes just to kick build again

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* Update hackathon.md

* fix broken links (docker#2808)

* fix broken link (docker#2809)

* [CONTRIBUTING] update broken link (docker#2826)

* [Debian] add gnupg2 requirement for stretch (docker#2823)

* TOC/redirect implementation

* Changing links to point to new tutorial

* Rewrites and asciinemas

* Fix bad merge

* Metadata, formatting

* Front page formatting, link instrumentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants