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.

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

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

Merged
merged 10 commits into from
Sep 17, 2024

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
coadaflorin
coadaflorin previously approved these changes Sep 5, 2024
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
Copy link
Contributor

@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 ❤️

@felicitymay felicitymay dismissed stale reviews from jc-clark and coadaflorin via 967367b September 6, 2024 11:30
felicitymay and others added 2 commits September 17, 2024 11:09
Update "About CodeQL" to cover the information needs of security researchers better
@felicitymay
Copy link
Contributor Author

@coadaflorin or @jc-clark - can I ask for another approval? Committing Joe's review suggestions dismissed your reviews.

I think that the update to the docs landing page will be published when we release CodeQL CLI 2.19.1.

@felicitymay felicitymay merged commit 0675ba0 into main Sep 17, 2024
7 checks passed
@felicitymay felicitymay deleted the 12707-felicity-docs-landing branch September 17, 2024 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation ready-for-doc-review This PR requires and is ready for review from the GitHub docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants