OpenLiberty / OpenLiberty/docs

Packaging and deploying applications

Open
#761 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
14
Forks
58
Avg merge
4m
Merged PRs (30d)
35

Description

Red Hat built the 'Packaging and deploying applications' guide on 10/16/2019. The PDF and HTML versions are attached here:

We need to determine if there's a better way to display pom.xml, server.xml, SystemReadinessCheck.java, and SystemLivenessCheck.java. Right now, they're included in the middle of the text, and some of them are included multiple times. We could try including them at the end of the guide in some sort of appendix. Then, each reference to one of these files/classes could link down to the appropriate file in the appendix section of the guide. This is assuming that the instances of each file are all the same. Restructuring the guides into this appendix/linking format could be a good starting point for usability testing to determine whether the linking would involve too much movement up and down the page.

It also appears the legal notice needs to be updated, but that may have already been addressed indirectly when we updated the legal notice for the docs.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the attached PDF and HTML guide, comparing every occurrence of pom.xml, server.xml, SystemReadinessCheck.java, and SystemLivenessCheck.java. Check whether the repeated examples are identical, then evaluate an appendix with links and verify whether the legal notice still needs updating; done means the guide structure and legal notice are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.