digitalocean / digitalocean/droplet_kit

Add docs for attributes for each resource

Open
#117 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
521
Forks
151
PR merge metrics
No merged PRs in 30d

Description

Right now it's a bit hard to see what attributes are available on each resource.

For example, I'm moving https://github.com/pearkes/tugboat to use `droplet_kit`, but it's missing a few of the attributes on the image side, and I had to dig into the code to find out. Adding docs for each attribute, using the docs from the API DigitalOcean docs.

I did some of this in #115, but it would be nice to have full coverage! 😄

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the resource documentation and the DigitalOcean API documentation for each resource, using the work in #115 as a reference. Document the available attributes with full resource coverage, including the missing image attributes, and verify that the documented lists match the API.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.