Skip to content

Fix heading levels and reorganize "Creating a workspace from code sample" #782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 19, 2019
Merged

Fix heading levels and reorganize "Creating a workspace from code sample" #782

merged 2 commits into from
Aug 19, 2019

Conversation

themr0c
Copy link
Contributor

@themr0c themr0c commented Aug 13, 2019

  • fix following errors when building the documentation
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 25: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 56: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 66: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 70: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 84: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 117: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 54: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 67: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 78: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_configuring-a-che-workspace-using-a-devfile.adoc: line 20: section title out of sequence: expected level 2, got level 3
asciidoctor: WARNING: proc_configuring-a-che-workspace-using-a-devfile.adoc: line 21: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 55: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 68: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc: line 79: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 26: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 57: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 67: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 71: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 85: section title out of sequence: expected level 1, got level 2
asciidoctor: WARNING: proc_creating-a-workspace-from-code-sample.adoc: line 118: section title out of sequence: expected level 1, got level 2
  • Includes also additional work on "Configuring a che workspace using a devfile" and "Creating a workspace from code sample" to make them more compatible with modular content.

  • Add an introduction on "Che quick starts" to have some target for links.

@themr0c themr0c changed the title [WIP] Fix heading levels in che7 docs Fix heading levels and reorganize "Creating a workspace from code sample": Aug 14, 2019
@themr0c themr0c changed the title Fix heading levels and reorganize "Creating a workspace from code sample": Fix heading levels and reorganize "Creating a workspace from code sample" Aug 14, 2019
Copy link

@rkratky rkratky left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@themr0c, in order to get {{site.baseurl}} to resolve in included files, they need to have :page-liquid: as the first line. Apologies for the confusion.

Please, update from master and apply this gimmick to your PR.

@@ -9,6 +9,7 @@ entries:
url: che-7/introduction-to-eclipse-che
output: web
- title: Che quick-starts
url: che-7/che-quick-starts
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@themr0c, this doesn't work. Can't be used.

Suggested change
url: che-7/che-quick-starts

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the fact that src/main/pages/che-7/overview/assembly_che-quick-starts.adoc has the necessary for that page to be generated, it works. And it would be very useful to point the user to a landing page for the quick starts.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@themr0c what I mean is that when you click this menu item in the navig sidebar, it won't open the page, even though it will be built. (Navig items that expand to reveal other items can't open their own page.)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@themr0c OK, I see now that you changed the navig structure, and the 'Che quick starts' item no longer expand -- instead, it opens its own page. Please, don't change thing like that without consulting it first.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK.

[discrete]
== Prerequisites

* A running instance of Eclipse Che. To install an instance of Eclipse Che see link:../che-quick-starts[Che quick-starts].
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* A running instance of Eclipse Che. To install an instance of Eclipse Che see link:../che-quick-starts[Che quick-starts].
* A running instance of Eclipse Che. To install an instance of Eclipse Che see link:{{site.baseurl}}/che-7/che-quick-starts[Che quick-starts].

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@themr0c, please, use the {{site.baseurl}} var for links. This relative inking isn't portable.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, no, just {site-baseurl} -- an AsciiDoc attribute.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack

@rkratky
Copy link

rkratky commented Aug 14, 2019

@themr0c, apologies, no {{site.baseurl}} and no :page-liquid: -- because of asciidoctor/jekyll-asciidoc#166, I had to resort to {site-baseurl} for paths. Defined in _config.yml and _config-war.yml.

@themr0c
Copy link
Contributor Author

themr0c commented Aug 19, 2019

Hi @rkratky, the PR is rebased against current master.

Unfortunately, I didn't manage to get functional links with {site-baseurl}, so I ended up with ../ again.

@rkratky rkratky merged commit 4909e39 into eclipse-che:master Aug 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants