Skip to content

Docs: Add Ruby to query help pages#6904

Merged
shati-patel merged 1 commit intogithub:rc/3.3from
shati-patel:ruby-query-help
Oct 18, 2021
Merged

Docs: Add Ruby to query help pages#6904
shati-patel merged 1 commit intogithub:rc/3.3from
shati-patel:ruby-query-help

Conversation

@shati-patel
Copy link
Copy Markdown
Contributor

@shati-patel shati-patel commented Oct 18, 2021

This PR adds Ruby to the table of contents for https://codeql.github.com/codeql-query-help/. The content itself (query help and CWE coverage) is added via internal automation, so this will appear when we publish 🙂 (This doesn't come under the "Docs - Generate Sphinx" PR check, but I've tested locally and everything seems to work as expected!)

image image

@hubwriter, tagging you for review since you've been coordinating the Ruby docs (there's not really much to review here, but let me know if anything's unclear!)


Linking the sibling PRs #6860 and #6887 for information (though this query help folder is published independently)


.. include:: ../reusables/query-help-overview.rst

For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/ruby/ql/examples>`__.
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link doesn't work yet, but it will do once Ruby is fully live 😄

@shati-patel shati-patel requested a review from hubwriter October 18, 2021 11:10
@shati-patel shati-patel marked this pull request as ready for review October 18, 2021 11:10
Copy link
Copy Markdown
Contributor

@hubwriter hubwriter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Thanks for the screenshots @shati-patel

@shati-patel shati-patel merged commit 702c647 into github:rc/3.3 Oct 18, 2021
@shati-patel shati-patel deleted the ruby-query-help branch October 18, 2021 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants