Skip to content

Commit

Permalink
Rewrote guidance on adding pages, code blocks, AsciiDoc basics, cross…
Browse files Browse the repository at this point in the history
… references, and editing documentation pages.

Reworked the contributing workflow for creating branches, installing antora, installing Git and an editor, configuring a playbook, configuring repositories, and building a test site.

Updated component terms.

Updated images to stop using Atom references and use VS Code.

Reworked the nav to stop having 2 different places for building the documentation site.
  • Loading branch information
sarahlwelton committed May 17, 2024
1 parent cae691b commit dd3ea60
Show file tree
Hide file tree
Showing 33 changed files with 743 additions and 713 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added home/modules/contribute/assets/images/explorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions home/modules/contribute/assets/images/git-branch.svg

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed home/modules/contribute/assets/images/new-branch.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
12 changes: 0 additions & 12 deletions home/modules/contribute/assets/images/repo.svg

This file was deleted.

Binary file added home/modules/contribute/assets/images/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions home/modules/contribute/examples/code-blocks.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// tag::dl-co[]
.Optional title
[source,java] // <1> <2>
---- // <3>
[source,java]
----
KStreamBuilder builder = new KStreamBuilder();
KStream<String, GenericRecord> source = builder
Expand Down
24 changes: 11 additions & 13 deletions home/modules/contribute/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,21 +1,20 @@
* xref:index.adoc[Overview]
* Setting Up Your Workspace
** xref:install-git-and-editor.adoc[Install Git and an AsciiDoc Editor]
** xref:install-antora.adoc[Install Antora]
** xref:playbook.adoc[Get the Site Playbook Project]
** xref:set-up-repository.adoc[Set Up Your Local Repository]
** xref:build-site.adoc[Build the Site]
** xref:install-git-and-editor.adoc[]
** xref:install-antora.adoc[]
** xref:set-up-repository.adoc[]
* Contributing Workflow
** xref:workflow-overview.adoc[Overview]
** xref:repositories.adoc[Repository Organization]
** xref:create-branches.adoc[Create a Working Branch]
** xref:edit-pages.adoc[Edit Existing Documentation]
** xref:add-pages.adoc[Add a New Documentation Page]
** xref:update-nav.adoc[Update a Navigation File]
** xref:test-site.adoc[Test Changes Locally]
** xref:send-pr.adoc[Send Changes for Review]
** xref:repositories.adoc[]
** xref:create-branches.adoc[]
** xref:edit-pages.adoc[]
** xref:add-pages.adoc[]
** xref:update-nav.adoc[]
** xref:playbook.adoc[]
** xref:test-site.adoc[]
** xref:send-pr.adoc[]
// ** Team Review Process
// ** Revise Changes
Expand All @@ -33,7 +32,6 @@
* Conventions & Styles
** xref:component-configuration.adoc[Component Structure and Configuration]
** xref:nav-menus-and-files.adoc[Navigation Menus and Files]
** xref:style-and-voice.adoc[Content Style and Voice]
* Technical details
** xref:generate-rest-api.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion home/modules/contribute/pages/add-pages.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ Any AsciiDoc file saved to a *pages* directory in an Antora documentation compon
== Next Steps

* xref:update-nav.adoc[Add a page to a component navigation menu].
* xref:build-site.adoc[Build the docs site locally to test and preview your changes].
* xref:test-site.adoc[Build the docs site locally to test and preview your changes].
10 changes: 0 additions & 10 deletions home/modules/contribute/pages/basics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -132,16 +132,6 @@ If you do not specify a URL, the default URL \http:https://localhost:8091 is used.
If you do not specify a URL, the default URL `+http:https://localhost:8091+` is used.
****

// == Checklists

// [source,asciidoc]
// ----
// include::example$lists.adoc[tag=check]
// ----

// Renders as:

// include::example$lists.adoc[tag=check]

== Description Lists

Expand Down
80 changes: 0 additions & 80 deletions home/modules/contribute/pages/build-site.adoc

This file was deleted.

Loading

0 comments on commit dd3ea60

Please sign in to comment.