Reduce duplication between help and readme #27
Conversation
|
I'm now thinking we should include descriptions of the inputs parameters to each action and how to use them. I say this after looking at at other actions (e.g. https://github.com/actions/checkout and https://github.com/actions/upload-artifact) and noting that the help docs don't mention these inputs. What do people think? |
I think that's a good minbar for this action. We want to give people a basic understanding of the action here, but can point them at the help documentation for more context. |
robertbrignull
force-pushed
the
slim-readme
branch
from
ddf1dff to
2b5fc3e
Compare
robertbrignull
force-pushed
the
slim-readme
branch
from
2b5fc3e to
b4610ac
Compare
|
Sorry it took a long time, but I've updated this PR with what I think is a better balance between providing information and reducing duplication. The readme now contains information about the action inputs which should be enough for most people, and mentions the existance of the config file but points to the docs for all technical details. |
| - src | ||
| - lib | ||
| ``` | ||
| The configuration file must be located within the local repository. For information on how to write a configuration file, see "[Using a custom configuration](https://help.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#using-a-custom-configuration)." |
There was a problem hiding this comment.
I didn't know that was a limitation we had. Would be interesting to see how much work it would take to allow a reference in another repository. This would allow us to handle shared configurations across an enterprise, for example.
There was a problem hiding this comment.
Good point. I've opened an issue for this.
This slims down the readme so we don't duplicate information that's already in the help docs so it'll be easier to keep it up to date. It does look a bit small now, but I'm not sure what else to put in it.
@jhutchings1 what are your thoughts?