OpenLiberty / OpenLiberty/docs

Build Gradle docs into the OL docs

Open
#1,611 1 comment 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

We need to build some of the Gradle docs into the OL docs. The Gradle docs may first need to be converted into AsciiDoc and then assessed to determine how we want to break them up and pull them into the OL docs. We may also want to do some editing of the Gradle docs before pulling them in.

See #1610 for a similar issue with Gradle docs. Consider these together.

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 Gradle docs repository linked in the issue and the similar work described in #1610. Assess the existing documentation, whether it needs AsciiDoc conversion, and how it should be organized for the OL docs; done means the selected Gradle content is edited and integrated into the OL documentation.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.