Skip to content

Create API-cheatsheet.md#320

Merged
rartych merged 2 commits intocamaraproject:mainfrom
Kevsy:patch-3
Jan 8, 2025
Merged

Create API-cheatsheet.md#320
rartych merged 2 commits intocamaraproject:mainfrom
Kevsy:patch-3

Conversation

@Kevsy
Copy link
Collaborator

@Kevsy Kevsy commented Oct 17, 2024

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

Adds a Cheatsheet document to help authors quickly get an answer to an editing question. The initial PR includes some example 'cheats' but is not complete.

Which issue(s) this PR fixes:

Fixes #319

Does this PR introduce a breaking change?

  • Yes
  • No

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

patrice-conil
patrice-conil previously approved these changes Oct 17, 2024
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

PedroDiez
PedroDiez previously approved these changes Oct 18, 2024
Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


| Information item | Convention | Example |
|------------------|------------|---------|
| API name | kebab-case | simple-edge-discovery |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add: | OAS file name | kebab-case | simple-edge-discovery.yaml |

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot thanks, added.

@Kevsy Kevsy dismissed stale reviews from PedroDiez and patrice-conil via aaa2315 November 6, 2024 16:27
Copy link
Contributor

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych added documentation Improvements or additions to documentation Spring25 labels Nov 18, 2024
Copy link
Contributor

@patrice-conil patrice-conil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@rartych rartych merged commit 65caf1f into camaraproject:main Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Spring25

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a CAMARA cheatsheet.md

5 participants