perfsonar / perfsonar/docs

Explain relationship between pScheduler exports and pSConfig template

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

Nobody has claimed this yet.

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

Description

In pSConfig's Tests section, there could stand to be a paragraph about the relationship between the output of pscheduler task --export and the JSON

E.g., the test section of this...

$ pscheduler task --export throughput --source foo --dest bar
{
    "test": {
        "spec": {
            "dest": "bar",
            "schema": 1,
            "source": "foo"
        },
        "type": "throughput"
    }
}

...gets put into a test in the pSConfig template with some parameter adjustment:

"tests": {
    "my_throughput": {
        "spec": {
            "dest": "{% address[1] %}",
            "schema": 1,
            "source": "{% address[0] %}"
        },
        "type": "throughput"
    }
}

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

Start with the pSConfig Templates Tests section at the linked documentation page and compare the two JSON examples in this issue. Add a paragraph explaining how the output of pscheduler task --export maps into a pSConfig test and how the source and destination parameters are adjusted; done means the relationship is clear from the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.