Replace all occurrences of
```foo
{% raw %}
bar
{% endraw %}
```
(which generates spurious empty lines in the rendered pre block) with
{% raw %}
```foo
bar
```
{% endraw %}
Also, fix some occurrences where the raw section is too large and
prevented interpretation of Jekyll directives.
This is the syntax used in the documentation of Jekyll itself:
https://raw.githubusercontent.com/jekyll/jekyll/master/docs/_docs/templates.md
FTR, done with two perl substitutions:
'^([\t ]*```[^\n]*
)([ \t]*\{% raw %\}[^\n]*
)' '$2$1'
and
'^([ \t]*\{% endraw %\}[^\n]*
)([\t ]*```[^\n]*
)' '$2$1'
and manually tweaks. A mechanical check would be most useful.
Signed-off-by: Akim Demaille <akim.demaille@docker.com>
* Reword lots of instances of 'will'
* Reword lots of instances of won't
* Reword lots of instances of we'll
* Eradicate you'll
* Eradicate 'be able to' type of phrases
* Eradicate 'unable to' type of phrases
* Eradicate 'has / have to' type of phrases
* Eradicate 'note that' type of phrases
* Eradicate 'in order to' type of phrases
* Redirect to official Chef and Puppet docs
* Eradicate gratuitous 'please'
* Reduce use of e.g.
* Reduce use of i.e.
* Reduce use of N.B.
* Get rid of 'sexagesimal' and correct some errors
* Add features to CLI ref template
- Differentiate CLI experimental from daemon experimental
- When the whole command is experimental, point to docs for
how to get it to show up
- Make badges links where possible
- Add tooltips to badges for more context
- Document in the test.md how to make badges into links and how to use tooltips
* Docs contributor guide: added links to subtopics on right side menu
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedits
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* more copyedits
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added back in some of the community pages by request
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added other ways to contribute to left side menu
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedits to contributor home page
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added links to Docker Community pages on GitHub
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* merged ways to contribute, made moby an include, re-org for tocs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed TOC yaml
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed on-page links on community page
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added note re: setting ENV variables for proxy servers in Dockerfile
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* review comments
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* reworded note title, removed link out to ENV per review comments
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added info to docs test page about how to link to auto-generated reference pages
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added more info to test on re: linking
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* format ENV as a command
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* how to get scp to work on Windows
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* clarified some commands in part 3
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed links on hyperv, machine pages
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* removing notes about scp and ssh on Windows, WIP
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* WIP: adding docker-machine env commands
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added docker-machine env option, re-worked tabs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* moved extra info re: docker-machine env out of note, to end of part 4
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* updated parts 4, 5 with docker-machine env, added note re: commands
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* changed rest of ssh examples, formatting fixes, copyedit
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedit on docker-machine env example
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* reworded note title
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added more info about resource constraints to Compose docs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed link in Compose docs, added instructions in test for adding custom target link link IDs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed links
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added <hr>'s below tabs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* update Tabs topic on test.md to show use of <hr>'s
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added more information about toc_max/min
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* better examples to show Compose file structure
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* cleaned up leading spaces in Compose file example
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* cleaned up leading spaces, added a test file
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* expand/collapse accordion full implementation, explanation in test.md
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* delete temporary test file from PR
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fix accordion to work on mobile (cursor style)
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* verified fix for mobile worked, added same to test.md, updated notes and content
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* Clarifed details on test page, fixed references for FontAwesome icons
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* Remove extraneous **warning**
The .warning class already prepends "Warning"
* changed Warning tag to vanilla
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* clarified logging options in Compose, fixed glaring note formats
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added link directly to JSON driver in supported drivers docs
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* took off code tags to make link stand out
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* fixed alignment of note text in markdown
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* x-ref to how to set environment variables in containers
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedit in note
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* admonitions with icons and FontAwesome
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* updated important and warning icons per review
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* experiments with glyphicons in admonitions (notes)
3 new admonition classes, re-write of test page
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* copyedit on code formatting
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* test Liquid admonitions with includes
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* renamed notes.html, reviewed Liquid relationship to CSS
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
* added description of Liquid variables experiments
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>