ml-opensource / ml-opensource/jenkinsfile-shared-libraries

Create a documentation site

Open
#7 0 comments 0 reactions 1 assignee View on GitHub

@Cliabhach is already working on this.

Since Feb 7, 2020.

enhancement
Dominant language
Groovy
Stars
3
Forks
0
No merged PRs in 30d

Description

We should be able to host this project's docs on GitHub, in the format of an API reference. I've never done that before, so part of this issue is just researching what options exist.

C.f. the following WIP documentation branches:

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.