leopardslab / leopardslab/nodecloud

Doc: Create documentation for NodeCloud vocabulary

Open
#26 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
95
Forks
87
PR merge metrics
No merged PRs in 30d

Description

Current documentation doesn't explain the vocabulary of NodeCloud in a convenient manner. New users should be able to use the services without going through extra hassle to find the matching services in cloud providers and NodeCloud APIs.

A documentation page can be created with the vocabulary of current set of APIs in NodeCloud matched with vocabulary of the cloud providers.

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.

Research direction

Review the current NodeCloud API vocabulary and the corresponding terminology used by AWS, GCP, and Azure. Create a documentation page that maps the current API terms to matching cloud-provider services; done means new users can identify the relevant provider service without searching through the APIs.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, azure, gcp, javascript, node.js
Domain
api, cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.