Skip to content

OpenLiberty/guides-common

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2abf92d · Feb 28, 2025
Feb 19, 2025
Mar 1, 2022
May 6, 2024
Feb 16, 2018
Nov 2, 2022
Jan 18, 2023
Feb 6, 2020
Feb 25, 2019
Feb 28, 2025
Aug 10, 2023
Aug 10, 2023
Aug 10, 2023
Oct 5, 2023
Aug 11, 2023
Aug 10, 2023
Aug 10, 2023
Oct 6, 2021
Mar 2, 2018
May 26, 2021
Sep 18, 2019
Jul 5, 2022
Feb 18, 2025
Feb 18, 2025
Feb 28, 2025
Jan 27, 2025
Sep 4, 2019
Jun 25, 2020
Jun 19, 2020
Feb 11, 2022
Aug 10, 2023
Jun 19, 2020
May 5, 2020
May 10, 2021
Nov 16, 2021
Nov 16, 2021
Nov 25, 2020
Sep 23, 2019
Sep 24, 2021
Mar 19, 2019
Aug 10, 2023
Apr 18, 2018
Aug 11, 2023
Aug 10, 2023

Repository files navigation

Writing guides guidelines

In this repository you will find a variety of common files and resources for writing the guides.

The common files include:

  • LICENSE (to be placed in every guide).
  • template.adoc guide template.
  • .gitignore common gitignore file (you should copy it into your guide repository. Feel free to edit it).
  • gitclone.adoc to place near the start of each guide for instructions on how to clone the guide repository and get started.
  • finish.adoc to place at the end of each guide.
  • mvnbuild.adoc to place near the end of the guide for maven build instructions.
  • mvncompile.adoc to place in the building section of the guide for instructions on how to repackage everything without having to restart the server.
  • mvnverify.adoc to place near the end of the guide for instructions on how to run the tests.
  • guide_tags.json to store tags for the guides. Full instructions for updating guide tags can be found in the guides-template.

For additional instructions including formatting, styling, etc. of the guides, visit the Wiki located in this repository.

Please pay close attention to the "Getting started" Wiki page. It contains important information that will not only help you make decisions when writing your guides but will also help keep all the guides concise and clean.