From d859e1e9a39042b1272e80bd3b558b6659d5c228 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Wed, 4 Jan 2023 16:43:17 -0500 Subject: [PATCH 01/11] add contributing info --- README.md | 2 ++ docs/codeql/CONTRIBUTING.MD | 9 +++++++++ docs/codeql/README.rst | 2 ++ 3 files changed, 13 insertions(+) create mode 100644 docs/codeql/CONTRIBUTING.MD diff --git a/README.md b/README.md index a1a91f8e0af..e0c34b1a6ba 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](https://github.com/github/codeql/blob/main/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..fca621030df --- /dev/null +++ b/docs/codeql/CONTRIBUTING.MD @@ -0,0 +1,9 @@ +# 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! + +**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that they appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. To contribute to these docs, which are located in the [`code-security`](https://github.com/github/docs/tree/main/content/code-security/code-scanning) directory, please refer to the [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. + +## Contributing to docs on `codeql.github.com` + +To make changes to the remaining documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/), you can make changes to the documentation files using the GitHub UI, a codespace, or making changes locally, 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-cli/), please see the [README](https://github.com/github/codeql/tree/main/docs/codeql#readme). diff --git a/docs/codeql/README.rst b/docs/codeql/README.rst index a07d15c27e1..1e8a55a9c24 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](/CONTRIBUTING.md)." + Project structure ***************** From a62a8d9960c27e41faf003089216b9dc74165912 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Wed, 4 Jan 2023 16:47:34 -0500 Subject: [PATCH 02/11] Update CONTRIBUTING.MD --- docs/codeql/CONTRIBUTING.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.MD index fca621030df..5b8c94e927c 100644 --- a/docs/codeql/CONTRIBUTING.MD +++ b/docs/codeql/CONTRIBUTING.MD @@ -2,7 +2,7 @@ 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! -**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that they appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. To contribute to these docs, which are located in the [`code-security`](https://github.com/github/docs/tree/main/content/code-security/code-scanning) directory, please refer to the [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. +**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that this documentation will appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. To contribute to these docs, which are located in the [`code-security`](https://github.com/github/docs/tree/main/content/code-security/code-scanning) directory, please refer to the [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. ## Contributing to docs on `codeql.github.com` From 745d30252c54f93e365b03d7187c4e27af2966bc Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Wed, 4 Jan 2023 16:49:27 -0500 Subject: [PATCH 03/11] Update CONTRIBUTING.MD --- docs/codeql/CONTRIBUTING.MD | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.MD index 5b8c94e927c..0c1fe8f9532 100644 --- a/docs/codeql/CONTRIBUTING.MD +++ b/docs/codeql/CONTRIBUTING.MD @@ -2,8 +2,14 @@ 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! -**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that this documentation will appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. To contribute to these docs, which are located in the [`code-security`](https://github.com/github/docs/tree/main/content/code-security/code-scanning) directory, please refer to the [CONTRIBUTING.md](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. +## Contributing to CodeQL docs on `docs.github.com` -## Contributing to docs on `codeql.github.com` +**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that this documentation will appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. + +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](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. + +## Contributing to CodeQL docs on `codeql.github.com` To make changes to the remaining documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/), you can make changes to the documentation files using the GitHub UI, a codespace, or making changes locally, 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-cli/), please see the [README](https://github.com/github/codeql/tree/main/docs/codeql#readme). + + From d079c7a5efb8493956e2570264513344ead10d04 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Fri, 6 Jan 2023 14:57:24 -0500 Subject: [PATCH 04/11] Apply suggestions from code review Co-authored-by: Felicity Chapman --- docs/codeql/CONTRIBUTING.MD | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.MD index 0c1fe8f9532..052d816787c 100644 --- a/docs/codeql/CONTRIBUTING.MD +++ b/docs/codeql/CONTRIBUTING.MD @@ -2,14 +2,17 @@ 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 `docs.github.com` +## Contributing to CodeQL CLI docs on `docs.github.com` -**Note**: We have recently copied the CodeQL CLI documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) to the public [github/docs](https://github.com/github/docs) repository so that this documentation will appear on the [GitHub Docs](https://docs.github.com/en/code-security/code-scanning) site. This includes all articles 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. + +We are in the process of moving all documentation about the CodeQL CLI from [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) 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 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. 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](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. ## Contributing to CodeQL docs on `codeql.github.com` -To make changes to the remaining documentation on [codeql.github.com](https://codeql.github.com/docs/codeql-cli/), you can make changes to the documentation files using the GitHub UI, a codespace, or making changes locally, 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-cli/), please see the [README](https://github.com/github/codeql/tree/main/docs/codeql#readme). +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](https://github.com/github/codeql/blob/main/docs/codeql/README.rst). From f15291a9deff443874a5ab4c851d722fdcd0ea74 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Fri, 6 Jan 2023 15:00:43 -0500 Subject: [PATCH 05/11] Change the order of sections --- docs/codeql/CONTRIBUTING.MD | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.MD index 052d816787c..478c2d28ac5 100644 --- a/docs/codeql/CONTRIBUTING.MD +++ b/docs/codeql/CONTRIBUTING.MD @@ -2,8 +2,11 @@ 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 CLI docs on `docs.github.com` +## 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](https://github.com/github/codeql/blob/main/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 [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) 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 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. This will make it easier for code scanning users to find information about using CodeQL to query their codebases. @@ -11,8 +14,5 @@ We are in the process of moving all documentation about the CodeQL CLI from [cod 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](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file in the `docs` repository. -## 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](https://github.com/github/codeql/blob/main/docs/codeql/README.rst). From 4acd1ababe111d37d3ec00fd004d22f5e8fbe0ec Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 12 Jan 2023 15:57:43 -0500 Subject: [PATCH 06/11] Update docs/codeql/CONTRIBUTING.MD Co-authored-by: Felicity Chapman --- docs/codeql/CONTRIBUTING.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.MD index 478c2d28ac5..ed07e78b1b9 100644 --- a/docs/codeql/CONTRIBUTING.MD +++ b/docs/codeql/CONTRIBUTING.MD @@ -8,7 +8,7 @@ To make changes to the documentation on [codeql.github.com](https://codeql.githu ## Contributing to CodeQL CLI docs on `docs.github.com` -We are in the process of moving all documentation about the CodeQL CLI from [codeql.github.com](https://codeql.github.com/docs/codeql-cli/) 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 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. This will make it easier for code scanning users to find information about using CodeQL to query their codebases. +We are in the process of moving all documentation about the CodeQL CLI from [github/codeql](https://github.com/github/codeql/tree/main/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. From c8298356dc44eca6dd984827b3a6f3a2fb339632 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Tue, 17 Jan 2023 12:32:36 -0500 Subject: [PATCH 07/11] Rename CONTRIBUTING.MD to CONTRIBUTING.md --- docs/codeql/{CONTRIBUTING.MD => CONTRIBUTING.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/codeql/{CONTRIBUTING.MD => CONTRIBUTING.md} (100%) diff --git a/docs/codeql/CONTRIBUTING.MD b/docs/codeql/CONTRIBUTING.md similarity index 100% rename from docs/codeql/CONTRIBUTING.MD rename to docs/codeql/CONTRIBUTING.md From 894a49418668728f3d678dcbdb92a126d6226d94 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 19 Jan 2023 09:39:55 -0500 Subject: [PATCH 08/11] Apply suggestions from code review Co-authored-by: Andrew Eisenberg --- README.md | 2 +- docs/codeql/CONTRIBUTING.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e0c34b1a6ba..b3a6158ac65 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ 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](https://github.com/github/codeql/blob/main/docs/codeql/CONTRIBUTING.md)" for docs. +For information on contributing to CodeQL documentation, see "[the contributing guide](docs/codeql/CONTRIBUTING.md)" for docs. ## License diff --git a/docs/codeql/CONTRIBUTING.md b/docs/codeql/CONTRIBUTING.md index ed07e78b1b9..7272b95f173 100644 --- a/docs/codeql/CONTRIBUTING.md +++ b/docs/codeql/CONTRIBUTING.md @@ -4,15 +4,15 @@ We welcome contributions to our CodeQL docs. Want to improve existing docs or ad ## 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](https://github.com/github/codeql/blob/main/docs/codeql/README.rst). +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](https://github.com/github/codeql/tree/main/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. +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](https://github.com/github/docs/blob/main/CONTRIBUTING.md) file 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. From 27a5051282fa249fd77f282d0477e6deb84fff1f Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 19 Jan 2023 09:45:01 -0500 Subject: [PATCH 09/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b3a6158ac65..57ecf54486c 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ 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. +For information on contributing to CodeQL documentation, see the "[contributing guide](docs/codeql/CONTRIBUTING.md)" for docs. ## License From a83a98226c4d6b408e5595d7d1f50762bad3b41a Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 19 Jan 2023 09:45:43 -0500 Subject: [PATCH 10/11] Update README.rst --- docs/codeql/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/codeql/README.rst b/docs/codeql/README.rst index 1e8a55a9c24..77069e2cc8f 100644 --- a/docs/codeql/README.rst +++ b/docs/codeql/README.rst @@ -12,7 +12,7 @@ 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)." +For information on contributing to CodeQL documentation, see the "[contributing guide](/CONTRIBUTING.md)." Project structure ***************** From 3a8479614bb8fa134e3e5be504bfef1cfd4c0451 Mon Sep 17 00:00:00 2001 From: Sarita Iyer <66540150+saritai@users.noreply.github.com> Date: Thu, 19 Jan 2023 15:13:34 -0500 Subject: [PATCH 11/11] fix link --- docs/codeql/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/codeql/README.rst b/docs/codeql/README.rst index 77069e2cc8f..70686aae436 100644 --- a/docs/codeql/README.rst +++ b/docs/codeql/README.rst @@ -12,7 +12,7 @@ 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)." +For information on contributing to CodeQL documentation, see the `contributing guide `__. Project structure *****************