perfsonar / perfsonar/docs

Documentation on docker sysctl image

Open
#214 0 comments 0 reactions 1 assignee View on GitHub

@DanielNeto is already working on this.

Since Feb 24, 2021.

docs.perfsonar.net enhancement
Dominant language
Python
Stars
5
Forks
7
Avg merge
1m
Merged PRs (30d)
1

Description

We should update http://docs.perfsonar.net/install_docker.html with info on the sysctl image. I would suggest something like the following:

  1. Create a section at the bottom called "Running the sysctl image" or similar
  2. In the section discuss what the image is, when it would be good to use and how to run it with docker-compose (you can do something similar to the docker-compose section right above it).

The docs are managed in this repo and the file that needs to be edited is here. They are all .rst file that you can convert to html using Sphinx with the "make html" target. You can see the README for more info.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.