hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-11 12:41:06 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11817 from github/saritai/docs-contributing-info

Browse Source 
Add CONTRIBUTING.MD file for contributing to docs
This commit is contained in:
Sarita Iyer
2023-01-20 12:41:20 -05:00
committed by GitHub
parent 9e6f9c2705 3a8479614b
commit f5406570f7
3 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/codeql/CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,18 @@
# Contributing to CodeQL docs
We welcome contributions to our CodeQL docs. Want to improve existing docs or add new information you think would be helpful? Then please go ahead and open a pull request!
## Contributing to CodeQL docs on `codeql.github.com`
To make changes to the documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-overview/), you can make changes to the documentation files using the GitHub UI, a codespace, or a local text editor, and then open a pull request for review. For more information about the format and structure of the CodeQL documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-overview/), please see the [README](docs/codeql/README.rst).
## Contributing to CodeQL CLI docs on `docs.github.com`
We are in the process of moving all documentation about the CodeQL CLI from [github/codeql](docs/codeql) to the public [github/docs](https://github.com/github/docs) repository so that this documentation is published on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles that are currently published under "[Using the CodeQL CLI](https://codeql.github.com/docs/codeql-cli/using-the-codeql-cli/)" and "[CodeQL CLI reference](https://codeql.github.com/docs/codeql-cli/codeql-cli-reference/)" categories on the CodeQL microsite. This will make it easier for code scanning users to find information about using CodeQL to query their codebases.
**Note**: For a brief time, we will have source files for CodeQL CLI documentation in two locations. During this period we will not accept changes to the old files in the `codeql` repository, only to the new files in the `docs` repository.
To contribute to these docs, which are located in the [`code-scanning`](https://github.com/github/docs/tree/main/content/code-security/code-scanning) directory, please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) file in the `docs` repository.

2
docs/codeql/README.rst
View File

@@ -12,6 +12,8 @@ see https://docutils.sourceforge.io/rst.html.
For more information on Sphinx, see https://www.sphinx-doc.org.
For information on contributing to CodeQL documentation, see the `contributing guide </CONTRIBUTING.md>`__.
Project structure
*****************