dev-sec / dev-sec/dev-sec.github.io

How to use documentation

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
22
Forks
15
Avg merge
4h 41m
Merged PRs (30d)
1

Description

Very simple step-for-step documentation how to use dev-sec assets would be nice (I get a such questions quite often), something like "Getting started guide":

  • step for step docs how to install inspec and run it with particular baseline
  • step for step docs how to apply hardening with ansible/puppet/chef

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 existing documentation structure in the dev-sec.github.io project before choosing where the guide belongs; no specific file or test is named. The work is complete when a step-by-step guide covers installing InSpec and running a baseline, plus applying hardening with Ansible, Puppet, and Chef.

Written by the indexing model from the issue text.

Assessment

Tech stack
ansible
Domain
devops, 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.