PaloAltoNetworks / PaloAltoNetworks/pan.dev
Issue with "Getting Started with twistcli"
Open
Nobody has claimed this yet.
documentation
- Dominant language
- MDX
- Stars
- 78
- Forks
- 88
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 18
Description
Documentation link
Describe the problem
-
space needed in
--docker-address PATH--docker-addressPATH-- Path to the Docker socket. By default, twistcli looks for the Docker socket in unix:///var/run/docker.sock. -
example command cut short:
$ ./twistcli images scan \ --address=<COMPUTE_CONSOLE> \ --user=<TW_USER> \ --password=<TW_PASSWORD> \ --docker-ad
Suggested fix
- add the space
- complete the example
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked twistcli Getting Started section, especially the example for scanning images when the Docker socket is not in its default location. Correct the missing space in --docker-address PATH and complete the truncated --docker-ad example; the documentation is done when the option text and command are complete and usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100