diff --git a/README.md b/README.md index a1a91f8e0af..57ecf54486c 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ There is [extensive documentation](https://codeql.github.com/docs/) on getting s We welcome contributions to our standard library and standard checks. Do you have an idea for a new check, or how to improve an existing query? Then please go ahead and open a pull request! Before you do, though, please take the time to read our [contributing guidelines](CONTRIBUTING.md). You can also consult our [style guides](https://github.com/github/codeql/tree/main/docs) to learn how to format your code for consistency and clarity, how to write query metadata, and how to write query help documentation for your query. +For information on contributing to CodeQL documentation, see the "[contributing guide](docs/codeql/CONTRIBUTING.md)" for docs. + ## License The code in this repository is licensed under the [MIT License](LICENSE) by [GitHub](https://github.com). diff --git a/docs/codeql/CONTRIBUTING.md b/docs/codeql/CONTRIBUTING.md new file mode 100644 index 00000000000..7272b95f173 --- /dev/null +++ b/docs/codeql/CONTRIBUTING.md @@ -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. + + + diff --git a/docs/codeql/README.rst b/docs/codeql/README.rst index a07d15c27e1..70686aae436 100644 --- a/docs/codeql/README.rst +++ b/docs/codeql/README.rst @@ -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 `__. + Project structure *****************