Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the Docs landing page for the CodeQL docs site #17361

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Update the Docs landing page for the CodeQL docs site #17361

wants to merge 5 commits into from
+147 −124

Conversation

felicitymay
Copy link
Contributor

These updates reflect the migration of documentation for CodeQL CLI and CodeQL for VS Code to the GitHub docs site.

In addition, the following changes are included:

  • Heading levels on the landing page adjusted for accessibility (no skipped levels)
  • Minor changes to the footer on the landing page to avoid redirects in links to content that's moved
  • New article on Running CodeQL queries written and added to the landing page
  • Template updated to match changes to the landing page

@felicitymay
Copy link
Contributor Author

To aid with reviewing, here are a couple of screenshots:

New docs landing page and revised drop-down menu:

Screenshot showing the content of the landing page and the drop-down menu. Demonstrates the new heading levels.

Revised footer for the docs landing page:

Screenshot showing the appearance of the footer with the new heading level.

New article:
Screenshot showing the preview of the new article on using CodeQL tools to run queries.

@felicitymay felicitymay marked this pull request as ready for review September 4, 2024 07:14
@felicitymay felicitymay added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Sep 4, 2024
@felicitymay felicitymay mentioned this pull request Sep 4, 2024
Open
coadaflorin
coadaflorin previously approved these changes Sep 5, 2024
View reviewed changes
Copy link
Contributor

@coadaflorin coadaflorin left a comment

Choose a reason for hiding this comment

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

This looks good to me. I was mostly reviewing the images you shared (Thank you for doing that!).

jc-clark
jc-clark previously approved these changes Sep 5, 2024
View reviewed changes
Copy link

@jc-clark jc-clark left a comment

Choose a reason for hiding this comment

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

This looks great from a docs content perspective! Thank you for the screenshots, those were very helpful ❤️

docs/codeql/writing-codeql-queries/running-codeql-queries.rst Outdated Show resolved Hide resolved
docs/codeql/writing-codeql-queries/running-codeql-queries.rst Outdated Show resolved Hide resolved
@felicitymay @jc-clark
Apply suggestions from code review
967367b 
Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coadaflorin coadaflorin coadaflorin left review comments

@jc-clark jc-clark jc-clark left review comments

@turbo turbo Awaiting requested review from turbo

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@felicitymay @coadaflorin @jc-clark