chef / chef/chef-server

Update RAML docs to be synced with chef-web-docs

Open
#1,702 0 comments 0 reactions 1 assignee View on GitHub

@markan is already working on this.

Since Jul 10, 2019.

Aspect: Documentation Status: Good First Issue Triage: Confirmed Type: Bug
Dominant language
Erlang
Stars
303
Forks
211
Avg merge
1d 8h
Merged PRs (30d)
5

Description

Describe the Enhancement:

The RAML docs in oc_erchef are not consistent with chef-web-docs. See https://github.com/chef/chef-web-docs/pull/1995 for some examples.

Describe the Need:

This is confusing.

Current Alternative

Look at chef-web-docs and try and reconcile.

Can We Help You Implement This?:

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.