tightening language and style in developers section @rdowner the Danger! was quite abrupt; is this softening fair? we don't want to be too off-putting!
Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/caad9bb9 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/caad9bb9 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/caad9bb9 Branch: refs/heads/master Commit: caad9bb90a92a6f40fd20a04fd759d47471011cf Parents: 1c99f6e Author: Alex Heneveld <[email protected]> Authored: Wed Jan 14 00:55:55 2015 +0000 Committer: Alex Heneveld <[email protected]> Committed: Wed Jan 14 00:55:55 2015 +0000 ---------------------------------------------------------------------- docs/style/css/base.scss | 45 +++++++++++++++++------ docs/website/developers/how-to-contribute.md | 9 ++--- docs/website/developers/index.md | 17 +++++---- 3 files changed, 48 insertions(+), 23 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/caad9bb9/docs/style/css/base.scss ---------------------------------------------------------------------- diff --git a/docs/style/css/base.scss b/docs/style/css/base.scss index cfbbdc0..9034e20 100644 --- a/docs/style/css/base.scss +++ b/docs/style/css/base.scss @@ -41,7 +41,29 @@ a[id]:empty, a[name]:empty { .btn-default { color: #666; } - +.panel-heading { + h4 { + padding-bottom: 0px; + margin-bottom: 0px; + } +} +.panel-body { + margin: 0px; + font-size: 95%; + color: #606060; + padding: 15px; + background-color: #fafafa; + border-radius: 5px; + p:first-child { + margin-top: 0px; + } + p:last-child { + margin-bottom: 0px; + } + > ul, > ol { + margin-left: -1em; + } +} /* GENERAL UTILS ----------------------------------------------------------------------- */ @@ -392,32 +414,33 @@ a:hover .octicon-footer { overflow-y: scroll; } -pre { +@mixin code() { font-family: Consolas, Lucida Console, Monaco, monospace; @include nowrap(); - background-color:$code_bg_color; + font-size: 85%; + /* override color and bg-color on 'code' from bootstrap, and a touch more padding on top since font-size is smaller */ + color: $text_color; + background-color: $code_bg_color; +} + +pre { + @include code(); padding: 0.4em 0.8em; overflow-x: scroll; - font-size: 85%; /* override border and line-height on 'pre' from bootstrap */ border: none; border-radius: 2px; line-height: 1; code { /* override settings on 'pre code' from bootstrap */ - font-size: 85%; + @include code(); line-height: 1; - @include nowrap(); /** and no padding since pre already has some */ padding: 0px; } } code { - font-family: Consolas, Lucida Console, Monaco, monospace; - font-size: 85%; - /* override color and bg-color on 'code' from bootstrap, and a touch more padding on top since font-size is smaller */ - color: black; - background-color:$code_bg_color; + @include code(); padding: 4px 4px 2px 4px; border-radius: 3px; } http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/caad9bb9/docs/website/developers/how-to-contribute.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/how-to-contribute.md b/docs/website/developers/how-to-contribute.md index 575c880..0c39521 100644 --- a/docs/website/developers/how-to-contribute.md +++ b/docs/website/developers/how-to-contribute.md @@ -18,12 +18,11 @@ process of making contributions to the Apache Brooklyn code base. </div> <div class="panel-body" markdown="1"> - 1. Pull request to [GitHub](http://github.com/apache/incubator-brooklyn). - 1. Sign the [Apache CLA](https://www.apache.org/licenses/#clas) if it's non-trivial. - 1. For bigger changes, open a [Jira](https://issues.apache.org/jira/browse/BROOKLYN) - and/or [email the list](../community/mailing-lists.html). +* Pull request to [GitHub](http://github.com/apache/incubator-brooklyn). +* Sign the [Apache CLA](https://www.apache.org/licenses/#clas) if it's non-trivial. +* For bigger changes, open a [Jira](https://issues.apache.org/jira/browse/BROOKLYN) + and/or [email the list](../community/mailing-lists.html). -You can do the above steps in reverse order, too. </div> </div> http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/caad9bb9/docs/website/developers/index.md ---------------------------------------------------------------------- diff --git a/docs/website/developers/index.md b/docs/website/developers/index.md index 265c898..8c1af7d 100644 --- a/docs/website/developers/index.md +++ b/docs/website/developers/index.md @@ -9,18 +9,21 @@ children: - { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } --- -Hello developers! These pages are aimed at people who want to get involved with reading, changing, testing and otherwise -working with the "bleeding edge" of code produced by our project. +Hello developers! +These pages are aimed at people who want to get involved with reading, changing, testing and otherwise +working with the bleeding edge Brooklyn code. <div class="panel panel-danger"> <div class="panel-heading" markdown="1"> -#### Danger! +#### Caution </div> <div class="panel-body" markdown="1"> -These pages contain information about accessing the "bleeding edge" code, and artifacts produced from it. Such code and -artifacts have not been formally released, and therefore The Apache Software Foundation has not performed any validation -or due diligence. They may contain bugs which cause data loss and other serious consequences. Proceed only if you -understand the potential consequences of using unreleased, untested code. +As these pages contain information about accessing the bleeding edge code and artifacts produced from it, +you should be aware that the code and binaries you will encounter may be unstable. +The Apache Software Foundation has not performed the level of validation and due diligence done +on formally released artifacts. +Proceed only if you understand the potential consequences of using unreleased code +and are comfortable doing so. </div> </div>
