Skip to content

Commit

Permalink
Adding chapter "Getting Help" (#1214)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahus1 committed Nov 26, 2022
1 parent a44af5f commit f0774cc
Show file tree
Hide file tree
Showing 8 changed files with 102 additions and 8 deletions.
3 changes: 2 additions & 1 deletion doc/users-guide/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
** xref:technical-writing/installing-intellij.adoc[]
** xref:technical-writing/starting-intellij-first-time.adoc[]
** xref:technical-writing/opening-the-first-project.adoc[]
** xref:technical-writing/editor-the-file-asciidoc-file.adoc[]
** xref:technical-writing/editing-an-asciidoc-file.adoc[]
** xref:technical-writing/navigating-in-a-project.adoc[]
** xref:technical-writing/searching-in-a-project.adoc[]
** xref:technical-writing/git-integration.adoc[]
** xref:technical-writing/preparing-a-repository.adoc[]
** xref:technical-writing/getting-help.adoc[]
* xref:installation.adoc[]
* xref:recommended-settings.adoc[]
* xref:features.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
= Editing an AsciiDoc file in IntelliJ
:navtitle: Editing an AsciiDoc file
:description: Adding a file to a project and editing AsciiDoc content in an existing project.
:page-aliases: technical-writing/editor-the-file-asciidoc-file.adoc

{description}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
= Getting help from docs and other users
:navtitle: Getting help
:description: This summarizes the different online forums where users of the plugin can get help from other users, and where they can discuss new ideas.

{description}

include::partial$technical-writing-series.adoc[]

Use this page if one of the pages in the user guide doesn't provide the necessary information, or to continue the learning journey of technical writing.

== Documentation resources for AsciiDoc, Asciidoctor and Antora

There are different documentation sites for different topics:

https://docs.asciidoctor.org/asciidoc/latest/[AsciiDoc Language Documentation]::
This is the reference documentation for the AsciiDoc language.
Find out which macros exist, how to format tables, links, lists etc.

https://docs.asciidoctor.org/asciidoctor/latest/[Asciidoctor Documentation]::
Learn about how to use the Asciidoctor implementation to convert AsciiDoc content to HTML and other formats on the command line or how to embed it into a build process.

https://asciidoctor.org/docs/asciidoc-recommended-practices/[AsciiDoc Recommended Practices]::
An opinionated list of common practices, and an explanation of the rule "`One Sentence Per Line`".

https://docs.asciidoctor.org/[Other Asciidoctor projects]::
An overview of related projects the community has built over the years.

[#asciidoc-community-chats-on-zulip]
== AsciiDoc community chats on Zulip

There are different Zulip chats for different topics.
Most of the content is accessible without registration, and users can search previous discussions to find answers to their questions.

Register for free and log-in to find more content, as not all channels are accessible without logging in first.
Posting questions and answers requires registration and logging in as well.

The maintainers of Asciidoctor and the AsciiDoc plugin for IntelliJ are active in all three Zulip chats.
Still, getting answers to new questions might take some hours or days.

https://asciidoctor.zulipchat.com/[Asciidoctor Zulip Chat]::
This chat covers questions and answers around Asciidoctor, the open source implementation to turn AsciiDoc content into HTML, PDF, epub and other formats.
Go to https://asciidoctor.zulipchat.com/ to join the chat, and have a look at https://asciidoctor.org/ to find out more about the project.

https://asciidoctor.zulipchat.com/[Antora Zulip Chat]::
This chat covers questions and answers around Antora, the open source multi-repository documentation site generator for tech writers that is based on AsciiDoc.
Go to https://antora.zulipchat.com/ to join the chat, and have a look at https://antora.org/ to find out more about the project.
On the website, scroll down to find a high-level summary of the project's features.
Click on menu:Docs[] in the upper right corner for an extensive documentation.

https://asciidoc.zulipchat.com/[AsciiDoc Zulip Chat]::
The AsciiDoc Working Group at Eclipse steers the future of the AsciiDoc Language.
Go to https://asciidoc.zulipchat.com/ to join the chat, and have a look at https://asciidoc.org/ and https://asciidoc-wg.ecipse.org/ to find out more about the working group's activities.

== GitHub

For questions around the plugin, to browse open issues and to join the discussion about the future roadmap, visit the https://github.com/asciidoctor/asciidoctor-intellij-plugin/issues[GitHub issues of the IntelliJ plugin project].

To read and search the issues, no registration is required.
To create issues and comments, register for a free GitHub account.

When creating a new issue, there is a category menu:Question / Discussion[] for general inquiries.

The maintainers of the AsciiDoc plugin for IntelliJ read the issues.
As this is a spare time project, answers might take days and sometimes more than a week.

In general, the responses are slower than in the <<asciidoc-community-chats-on-zulip>>.
On the other hand follow-up activities are better tracked on GitHub issues.

== Write-the-Docs community

The Write The Docs community provides a website for technical writers at https://www.writethedocs.org/, organizes conferences around the world which make their recordings available free of charge, and supports the community with a publicly available Slack channel.

The Slack instance has many channels, for example #asciidoc, #static-site-generator and #docs-as-code.
They might give additional insights, still the <<asciidoc-community-chats-on-zulip,Zulip chats mentioned above>> seem to be more active and more focused on AsciiDoc content at the time of writing.

Use the chat to get answers to your questions, and help others with their questions.

== Meetups (online and in-person)

The Write-the-Docs community offers local meetups.
See https://www.writethedocs.org/meetups/ for a list.
Join the Write-the-Docs Slack instance and watch the channel #meetups to see postings of upcoming meetings.

There's also the Meetup https://www.meetup.com/continuous-documentation-regulars[Continuous Documentation Regulars] which is happens to be hosted by the maintainer of the AsciiDoc plugin.
Expect topics around documentation as code in general, not necessarily focused on AsciiDoc only.

== Further reading

This can't capture all activities in the community.
Use the chats listed above to find out more, and come back here and contribute content to this page by clicking on the menu:Edit[] link in the upper right corner.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ include::partial$technical-writing-series.adoc[]
== Prerequisites

This assumes that IntelliJ IDEA is already installed on the PC and is started and that the reader is familiar with editing content in IntelliJ.
See xref:./installing-intellij.adoc[] and xref:./editor-the-file-asciidoc-file.adoc[] on how to do this.
See xref:./installing-intellij.adoc[] and xref:./editing-an-asciidoc-file.adoc[] on how to do this.

In order for the Git functionality in IntelliJ to work, the user needs to install a Git client.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,12 @@ To get a full overview of all features of the plugin, see xref:features.adoc[].
Follow these steps to set up IntelliJ IDEA as the tool for technical writing.
Each page gives a brief overview to get started and links to other pages in this guide for additional information.

If the information in the following pages is missing an aspect and leaves questions unanswered, visit the xref:./getting-help.adoc[] page to find more documentation resources and learn where to contact other users of the plugin to collaborate and to get answers to questions.

. xref:./installing-intellij.adoc[Installing IntelliJ IDEA as the workplace for technical writing].
. xref:./starting-intellij-first-time.adoc[Starting IntelliJ IDEA for the first time and installing the AsciiDoc plugin].
. xref:./opening-the-first-project.adoc[Opening the first project in IntelliJ IDEA].
. xref:./editor-the-file-asciidoc-file.adoc[Adding a file to a project and editing AsciiDoc content in an existing project.].
. xref:./editing-an-asciidoc-file.adoc[Adding a file to a project and editing AsciiDoc content in an existing project].
. xref:./navigating-in-a-project.adoc[Navigating from one file to other referenced files in a project].
. xref:./searching-in-a-project.adoc[Searching AsciiDoc content in a project].
. xref:./git-integration.adoc[Collaborate with others using IntelliJ IDEA's Git integration].
Expand All @@ -45,4 +47,4 @@ If there are missing features, link:mailto:[email protected]?subject=Fe

To get a full overview of all features of the plugin, see xref:features.adoc[].

To custom the plugin's settings, see xref:recommended-settings.adoc[] for recommended settings.
To customize the plugin's settings, see xref:recommended-settings.adoc[] for recommended settings.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ include::partial$technical-writing-series.adoc[]
== Prerequisites

This assumes that IntelliJ IDEA is open with a project with some existing content.
See xref:./opening-the-first-project.adoc[] and xref:./editor-the-file-asciidoc-file.adoc[] on how to do this.
See xref:./opening-the-first-project.adoc[] and xref:./editing-an-asciidoc-file.adoc[] on how to do this.

== Navigating in an AsciiDoc project

Expand Down Expand Up @@ -70,7 +70,7 @@ If the content is from an included AsciiDoc file, the editor opens that file in
=== Navigation in the structure tool window

The structure view is usually hidden.
The user opens and hides it by clicking on menu:Structure[] in the tool border of the IDE's window.
The user opens and hides it by clicking on menu:Structure[] in the tool border of the IDE's window in the lower left corner.

image::technical-writing/intellij-structure-view.png[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ The same options are also available when a project is open from the menu via men

== Further reading

Continue to xref:./editor-the-file-asciidoc-file.adoc[] for the next step of this series.
Continue to xref:./editing-an-asciidoc-file.adoc[] for the next step of this series.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::partial$technical-writing-series.adoc[]
== Prerequisites

This assumes that IntelliJ IDEA is open with a project with some existing content.
See xref:./opening-the-first-project.adoc[] and xref:./editor-the-file-asciidoc-file.adoc[] on how to do this.
See xref:./opening-the-first-project.adoc[] and xref:./editing-an-asciidoc-file.adoc[] on how to do this.

== Searching within an AsciiDoc project

Expand Down

0 comments on commit f0774cc

Please sign in to comment.