You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2019/01/02 06:54:40 UTC
[isis] branch 2062-antora created (now c378fcb)
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a change to branch 2062-antora
in repository https://gitbox.apache.org/repos/asf/isis.git.
at c378fcb 2062: ignores build directory
This branch includes the following new commits:
new cf1a1f1 2062: adds scaffolding
new c378fcb 2062: ignores build directory
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
[isis] 01/02: 2062: adds scaffolding
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch 2062-antora
in repository https://gitbox.apache.org/repos/asf/isis.git
commit cf1a1f14ab3af120cde16dc11dee1bda15cd72b1
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Tue Jan 1 17:12:01 2019 +0000
2062: adds scaffolding
---
.gitignore | 1 +
adocs/_notes.adoc | 36 ++++++++++++++++++++++
adocs/antora.yml | 6 ++++
adocs/modules/ROOT/_attributes.adoc | 0
adocs/modules/ROOT/assets/.gitkeep | 0
adocs/modules/ROOT/assets/attachments/.gitkeep | 0
adocs/modules/ROOT/assets/images/.gitkeep | 0
adocs/modules/ROOT/examples/.gitkeep | 0
adocs/modules/ROOT/nav.adoc | 17 ++++++++++
adocs/modules/ROOT/pages/_attributes.adoc | 2 ++
adocs/modules/ROOT/pages/_partials/.gitkeep | 0
adocs/modules/ROOT/pages/page-A.adoc | 3 ++
adocs/modules/_example-module/_attributes.adoc | 0
adocs/modules/_example-module/assets/.gitkeep | 0
.../_example-module/assets/attachments/.gitkeep | 0
.../modules/_example-module/assets/images/.gitkeep | 0
adocs/modules/_example-module/examples/.gitkeep | 0
adocs/modules/_example-module/nav.adoc | 1 +
.../modules/_example-module/pages/_attributes.adoc | 2 ++
.../_example-module/pages/_partials/.gitkeep | 0
adocs/modules/_example-module/pages/page-1.adoc | 3 ++
antora-site.yml | 17 ++++++++++
22 files changed, 88 insertions(+)
diff --git a/.gitignore b/.gitignore
index 4d7509d..383c335 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,3 +47,4 @@ rebel.xml
**/.DS_Store
.flattened-pom.xml
+.cache/
diff --git a/adocs/_notes.adoc b/adocs/_notes.adoc
new file mode 100644
index 0000000..89c837c
--- /dev/null
+++ b/adocs/_notes.adoc
@@ -0,0 +1,36 @@
+= notes
+
+I'm thinking that initially we just use antora for the reference and user guides, but leave the top-level as is.
+
+The table-of-contents could probably become the ROOT module.
+
+
+
+
+== docs.antora.org
+
+Looking at how docs.antora.org works:
+
+* playbook in https://gitlab.com/antora/docs.antora.org[]
+
+** named (`antora-playbook.yml` rather than the usual `site.yml`, so build using `antora antora-playbook.yml`
+
+** also includes `docsearch` for their nice search capability
+
+* single module (multiple branches) is the codebase itself, ie https://gitlab.com/antora/antora[]
+
+** in particular, https://gitlab.com/antora/antora/tree/master/docs[/tree/master/docs] subdir.
+
+** holds `antora.yml` which is the module descriptor
+
+
+In the module we see the required (opinionated) module structure.
+
+
+== couchbase docs
+
+https://github.com/couchbase/docs-ui
+
+ui:
+ bundle:
+ url: https://github.com/couchbase/docs-ui/releases/download/v194/ui-bundle.zip
diff --git a/adocs/antora.yml b/adocs/antora.yml
new file mode 100644
index 0000000..5c7f12f
--- /dev/null
+++ b/adocs/antora.yml
@@ -0,0 +1,6 @@
+name: isis
+version: '1.x'
+title: Apache Isis
+nav:
+- modules/ROOT/nav.adoc
+# - modules/_example-module/nav.adoc
diff --git a/adocs/modules/ROOT/_attributes.adoc b/adocs/modules/ROOT/_attributes.adoc
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/assets/.gitkeep b/adocs/modules/ROOT/assets/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/assets/attachments/.gitkeep b/adocs/modules/ROOT/assets/attachments/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/assets/images/.gitkeep b/adocs/modules/ROOT/assets/images/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/examples/.gitkeep b/adocs/modules/ROOT/examples/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/nav.adoc b/adocs/modules/ROOT/nav.adoc
new file mode 100644
index 0000000..ef740e8
--- /dev/null
+++ b/adocs/modules/ROOT/nav.adoc
@@ -0,0 +1,17 @@
+* xref:page-A.adoc[Page A]
+
+//* xref:index.adoc[Playbook]
+////*** xref:playbook-formats.adoc[File Formats]
+//** xref:playbook-schema.adoc[Configuration Schema]
+//*** xref:configure-site.adoc[Site]
+//*** xref:configure-content-sources.adoc[Content Sources]
+//**** xref:private-repository-auth.adoc[Private Repository Authentication]
+//*** xref:configure-asciidoc.adoc[AsciiDoc]
+//*** xref:configure-ui.adoc[UI]
+////*** xref:configure-redirects.adoc[Configure Redirects]
+//*** xref:configure-output.adoc[Output]
+//*** xref:configure-runtime.adoc[Runtime]
+//// ** Create a Playbook
+//** xref:author-mode.adoc[Create an Author Workspace]
+////** xref:playbook-project.adoc[Playbook Projects]
+//** xref:use-an-existing-playbook-project.adoc[Use an Existing Project]
diff --git a/adocs/modules/ROOT/pages/_attributes.adoc b/adocs/modules/ROOT/pages/_attributes.adoc
new file mode 100644
index 0000000..fb98244
--- /dev/null
+++ b/adocs/modules/ROOT/pages/_attributes.adoc
@@ -0,0 +1,2 @@
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
diff --git a/adocs/modules/ROOT/pages/_partials/.gitkeep b/adocs/modules/ROOT/pages/_partials/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/ROOT/pages/page-A.adoc b/adocs/modules/ROOT/pages/page-A.adoc
new file mode 100644
index 0000000..d9434e1
--- /dev/null
+++ b/adocs/modules/ROOT/pages/page-A.adoc
@@ -0,0 +1,3 @@
+= page-1
+
+Hi, this is page-1.
\ No newline at end of file
diff --git a/adocs/modules/_example-module/_attributes.adoc b/adocs/modules/_example-module/_attributes.adoc
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/assets/.gitkeep b/adocs/modules/_example-module/assets/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/assets/attachments/.gitkeep b/adocs/modules/_example-module/assets/attachments/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/assets/images/.gitkeep b/adocs/modules/_example-module/assets/images/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/examples/.gitkeep b/adocs/modules/_example-module/examples/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/nav.adoc b/adocs/modules/_example-module/nav.adoc
new file mode 100644
index 0000000..ea6becc
--- /dev/null
+++ b/adocs/modules/_example-module/nav.adoc
@@ -0,0 +1 @@
+* xref:page-1.adoc[Page 1]
diff --git a/adocs/modules/_example-module/pages/_attributes.adoc b/adocs/modules/_example-module/pages/_attributes.adoc
new file mode 100644
index 0000000..3b366f9
--- /dev/null
+++ b/adocs/modules/_example-module/pages/_attributes.adoc
@@ -0,0 +1,2 @@
+:moduledir: ..
+include::{moduledir}/_attributes.adoc[]
\ No newline at end of file
diff --git a/adocs/modules/_example-module/pages/_partials/.gitkeep b/adocs/modules/_example-module/pages/_partials/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/adocs/modules/_example-module/pages/page-1.adoc b/adocs/modules/_example-module/pages/page-1.adoc
new file mode 100644
index 0000000..d9434e1
--- /dev/null
+++ b/adocs/modules/_example-module/pages/page-1.adoc
@@ -0,0 +1,3 @@
+= page-1
+
+Hi, this is page-1.
\ No newline at end of file
diff --git a/antora-site.yml b/antora-site.yml
new file mode 100644
index 0000000..fc606a9
--- /dev/null
+++ b/antora-site.yml
@@ -0,0 +1,17 @@
+site:
+ title: Apache Isis
+ # the 404 page and sitemap files only get generated when the url property is set
+ # url: https://isis.apache.org/antora
+ # start_page: _example-module::pages/page-A.adoc
+content:
+ sources:
+ - url: ./
+ start_path: adocs
+ branches: [2062-antora]
+runtime:
+ fetch: true
+ cache_dir: ./.cache/antora
+ui:
+ bundle:
+ url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
+ snapshot: true
\ No newline at end of file
[isis] 02/02: 2062: ignores build directory
Posted by da...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch 2062-antora
in repository https://gitbox.apache.org/repos/asf/isis.git
commit c378fcb50751dbb5a741585934ee1590eba7b9f5
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Wed Jan 2 06:54:17 2019 +0000
2062: ignores build directory
---
.gitignore | 1 +
1 file changed, 1 insertion(+)
diff --git a/.gitignore b/.gitignore
index 383c335..4dc882b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -48,3 +48,4 @@ rebel.xml
.flattened-pom.xml
.cache/
+build/