saltstack / saltstack/salt

[DOCS] Extending Salt Cloud - outdated example of module that is using libcloud

Open
#58,719 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-rework documentation P1 Salt-Cloud severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
An example to follow for writing a cloud driver module based on libcloud is the Linode module which is not using libcloud since 2015:
Move Linode driver to use REST API instead of libcloud

Suggested Fix
Add example of cloud driver module that is using libcloud

Type of documentation
Salt documentation

Location or format of documentation
WRITING CLOUD DRIVER MODULES

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.

Research direction

Start with the WRITING CLOUD DRIVER MODULES section at the linked Salt documentation location and compare its Linode example with the current cloud driver modules. Identify an existing module that still uses libcloud, then update the documentation example. Done means the page points newcomers to an accurate libcloud-based example instead of Linode.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.