From c7ba37318b37803127f63a2fa2d40dd95c906517 Mon Sep 17 00:00:00 2001 From: Valentin Aitken Date: Fri, 19 May 2017 16:45:40 +0300 Subject: [PATCH 1/2] Merge guide/dev into website/developers --- guide/dev/index.md | 42 ------------------ guide/misc/index.md | 2 +- guide/ops/osgi.md | 2 + .../developers}/code/licensing.md | 0 .../developers}/code/structure.md | 0 .../dev => website/developers}/code/tests.md | 0 .../developers}/env/ide/eclipse.include.md | 0 .../developers}/env/ide/index.md | 0 .../developers}/env/maven-build.md | 0 website/developers/index.md | 44 ++++++++++++++++--- .../tips/debugging-remote-brooklyn.md | 0 .../dev => website/developers}/tips/index.md | 0 .../developers}/tips/logging.md | 0 website/documentation/index.md | 2 +- website/index.md | 1 - 15 files changed, 41 insertions(+), 52 deletions(-) delete mode 100644 guide/dev/index.md rename {guide/dev => website/developers}/code/licensing.md (100%) rename {guide/dev => website/developers}/code/structure.md (100%) rename {guide/dev => website/developers}/code/tests.md (100%) rename {guide/dev => website/developers}/env/ide/eclipse.include.md (100%) rename {guide/dev => website/developers}/env/ide/index.md (100%) rename {guide/dev => website/developers}/env/maven-build.md (100%) rename {guide/dev => website/developers}/tips/debugging-remote-brooklyn.md (100%) rename {guide/dev => website/developers}/tips/index.md (100%) rename {guide/dev => website/developers}/tips/logging.md (100%) diff --git a/guide/dev/index.md b/guide/dev/index.md deleted file mode 100644 index f0cf45e9..00000000 --- a/guide/dev/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Developer Guide -started-pdf-exclude: true -layout: website-normal -menu_parent: /website/documentation/ -breadcrumbs: -- /website/documentation/index.md -- /guide/dev/index.md -children: -- { link: "{{ site.path.website }}/developers/code/", title: "Get the Code" } -- env/maven-build.md -- env/ide/ -- code/structure.md -- code/tests.md -- code/licensing.md -- tips/ -- tips/logging.md -- tips/debugging-remote-brooklyn.md -- { link: "http://github.com/apache/brooklyn", title: "GitHub" } -- { link: "https://brooklyn.apache.org/v/latest/misc/javadoc", title: "Javadoc" } ---- - -{% comment %} -TODO - -The Developer Guide contains information on working with the Brooklyn codebase. - -Of particular note to people getting started, there is: - -* Help with Maven -* Help with Git -* Help setting up IDE's - -And for the Brooklyn codebase itself, see: - -* Project structure -* Areas of Special Hairiness - -(All links are TODO.) -{% endcomment %} - -{% include list-children.html %} diff --git a/guide/misc/index.md b/guide/misc/index.md index 864f0702..7b9d113c 100644 --- a/guide/misc/index.md +++ b/guide/misc/index.md @@ -9,7 +9,7 @@ children: - release-notes.md - migrate-to-0.8.0.md - known-issues.md -- { path: ../dev/, title_in_menu: "Developer Guide" } +- { path: /website/developers/, title_in_menu: "Developer Guide" } - { path: /website/documentation/, title_in_menu: "All Documentation", menu_customization: { force_inactive: true } } --- diff --git a/guide/ops/osgi.md b/guide/ops/osgi.md index 97becec1..4a1a30c9 100644 --- a/guide/ops/osgi.md +++ b/guide/ops/osgi.md @@ -65,6 +65,8 @@ JAVA_DEBUG_OPTS='-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5 For other options please check your JVM JPDA documentation. Hotspot JPDA: https://docs.oracle.com/javase/8/docs/technotes/guides/jpda/ +## Quick testing + ## Configuring Configuration of Brooklyn when running under Karaf is largely done through standard Karaf mechanisms. diff --git a/guide/dev/code/licensing.md b/website/developers/code/licensing.md similarity index 100% rename from guide/dev/code/licensing.md rename to website/developers/code/licensing.md diff --git a/guide/dev/code/structure.md b/website/developers/code/structure.md similarity index 100% rename from guide/dev/code/structure.md rename to website/developers/code/structure.md diff --git a/guide/dev/code/tests.md b/website/developers/code/tests.md similarity index 100% rename from guide/dev/code/tests.md rename to website/developers/code/tests.md diff --git a/guide/dev/env/ide/eclipse.include.md b/website/developers/env/ide/eclipse.include.md similarity index 100% rename from guide/dev/env/ide/eclipse.include.md rename to website/developers/env/ide/eclipse.include.md diff --git a/guide/dev/env/ide/index.md b/website/developers/env/ide/index.md similarity index 100% rename from guide/dev/env/ide/index.md rename to website/developers/env/ide/index.md diff --git a/guide/dev/env/maven-build.md b/website/developers/env/maven-build.md similarity index 100% rename from guide/dev/env/maven-build.md rename to website/developers/env/maven-build.md diff --git a/website/developers/index.md b/website/developers/index.md index 4f0e605d..a374c751 100644 --- a/website/developers/index.md +++ b/website/developers/index.md @@ -5,12 +5,22 @@ started-pdf-exclude: true children: - code/ - how-to-contribute.md -- /guide/dev/ - committers/ - code-standards.md - links.md - { link: 'http://github.com/apache/brooklyn', title: 'GitHub' } - { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } +- { link: "{{ site.path.website }}/developers/code/", title: "Get the Code" } +- env/maven-build.md +- env/ide/ +- code/structure.md +- code/tests.md +- code/licensing.md +- tips/ +- tips/logging.md +- tips/debugging-remote-brooklyn.md +- { link: "http://github.com/apache/brooklyn", title: "GitHub" } +- { link: "https://brooklyn.apache.org/v/latest/misc/javadoc", title: "Javadoc" } --- Hello developers! @@ -24,15 +34,15 @@ working with the bleeding edge Brooklyn 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. +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.
We heartily welome contributions and new members. -There's nothing official needed to get involved; +There's nothing official needed to get involved; simply come say hello somewhere in the [community](../community/index.html): - [Mailing lists](../community/mailing-lists.html) @@ -41,10 +51,30 @@ simply come say hello somewhere in the [community](../community/index.html): Then [get the code](code/). -When you have a blueprint or an improvement you want to share, +When you have a blueprint or an improvement you want to share, there are a few instructions to note on [how to contribute](how-to-contribute.html). -If you're looking to learn more about the codebase itself, -have a look at [Developer Guide]({{ site.path.guide }}/dev/). There are also a number of [development bookmarks](links.html) for the tools we use (git, jenkins, jira). + + +{% comment %} +TODO + +The Developer Guide contains information on working with the Brooklyn codebase. + +Of particular note to people getting started, there is: + +* Help with Maven +* Help with Git +* Help setting up IDE's + +And for the Brooklyn codebase itself, see: + +* Project structure +* Areas of Special Hairiness + +(All links are TODO.) +{% endcomment %} + +{% include list-children.html %} diff --git a/guide/dev/tips/debugging-remote-brooklyn.md b/website/developers/tips/debugging-remote-brooklyn.md similarity index 100% rename from guide/dev/tips/debugging-remote-brooklyn.md rename to website/developers/tips/debugging-remote-brooklyn.md diff --git a/guide/dev/tips/index.md b/website/developers/tips/index.md similarity index 100% rename from guide/dev/tips/index.md rename to website/developers/tips/index.md diff --git a/guide/dev/tips/logging.md b/website/developers/tips/logging.md similarity index 100% rename from guide/dev/tips/logging.md rename to website/developers/tips/logging.md diff --git a/website/documentation/index.md b/website/documentation/index.md index 80f95556..32689d56 100644 --- a/website/documentation/index.md +++ b/website/documentation/index.md @@ -4,7 +4,7 @@ title: Documentation started-pdf-exclude: true children: - /guide/ -- /guide/dev/ +- ../developers/ - ../meta/versions.md - other-docs.md --- diff --git a/website/index.md b/website/index.md index 2bc26c40..186776f7 100644 --- a/website/index.md +++ b/website/index.md @@ -12,7 +12,6 @@ children: - { path: /guide/locations/index.md, title_in_menu: Deploying Blueprints } - { path: /guide/ops/index.md, title_in_menu: Reference Guide, menu_customization: { dropdown_section_header: true } } - - { path: /guide/dev/index.md, title_in_menu: Developer Guide } - { path: meta/versions.md, title_in_menu: Versions, menu_customization: { dropdown_new_section: true } } - { path: documentation/other-docs.md, title_in_menu: Other Resources } From df194ec1f10cdaf55fe7ee35af6a6b37ff500b9f Mon Sep 17 00:00:00 2001 From: Valentin Aitken Date: Fri, 19 May 2017 17:24:15 +0300 Subject: [PATCH 2/2] Remove documentation > developers relationship --- website/developers/index.md | 11 ++++------- website/documentation/index.md | 1 - 2 files changed, 4 insertions(+), 8 deletions(-) diff --git a/website/developers/index.md b/website/developers/index.md index a374c751..13510241 100644 --- a/website/developers/index.md +++ b/website/developers/index.md @@ -1,26 +1,23 @@ --- layout: website-normal title: Developers -started-pdf-exclude: true +menu_parent: index.md children: - code/ - how-to-contribute.md - committers/ - code-standards.md - links.md -- { link: 'http://github.com/apache/brooklyn', title: 'GitHub' } -- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } -- { link: "{{ site.path.website }}/developers/code/", title: "Get the Code" } - env/maven-build.md - env/ide/ -- code/structure.md -- code/tests.md -- code/licensing.md +- code/ - tips/ - tips/logging.md - tips/debugging-remote-brooklyn.md - { link: "http://github.com/apache/brooklyn", title: "GitHub" } - { link: "https://brooklyn.apache.org/v/latest/misc/javadoc", title: "Javadoc" } +- { link: 'http://github.com/apache/brooklyn', title: 'GitHub' } +- { link: 'https://issues.apache.org/jira/browse/BROOKLYN', title: 'Bug Tracker (JIRA)' } --- Hello developers! diff --git a/website/documentation/index.md b/website/documentation/index.md index 32689d56..342c9f95 100644 --- a/website/documentation/index.md +++ b/website/documentation/index.md @@ -4,7 +4,6 @@ title: Documentation started-pdf-exclude: true children: - /guide/ -- ../developers/ - ../meta/versions.md - other-docs.md ---