Skip to content

"CodeQL for X" docs: update "Further reading" sections #3409

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

Merged
merged 3 commits into from
May 7, 2020

Conversation

jf205
Copy link
Contributor

@jf205 jf205 commented May 5, 2020

Partially fixes https://github.com/github/semmle-docs/issues/68.

This updates the "Further reading" sections for the "CodeQL for X" topics to follow the GitHub style. Detail in the above issue. Other sections of the docs will be dealt with in separate PRs. This is dull--apologies to the reviewer.

Change Preview Source Comment
Add reusable for links to CodeQL tools and QL language ref n/a source The CodeQL tools article will go live when we update the docs for the next CodeQL release.
Add reusables for language-specific pages n/a sources
Remove "Further reading" sections from "CodeQL for X" map topics e.g. CodeQL for C and C++ source See current version on help.semmmle.com
Refactor further reading sections in CodeQL for X tutorials C and C++ example, C# example, Go example, Java example, JavaScript example, Python example sources See current versions on help.semmle.com: example

@jf205 jf205 changed the base branch from master to rc/1.24 May 5, 2020 09:10
@jf205 jf205 marked this pull request as ready for review May 5, 2020 09:31
@jf205 jf205 requested a review from shati-patel as a code owner May 5, 2020 09:31
Copy link
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.

This seems fine except for the "CodeQL tools" link
https://help.semmle.com/codeql/codeql-tools.html
This gives me a page not found.

Cosmetic: the spacing is a little odd in these lists, but I realise this is just a stepping stone to getting this documentation into GitHub.

@jf205
Copy link
Contributor Author

jf205 commented May 5, 2020

Thanks @hubwriter.

Cosmetic: the spacing is a little odd in these lists, but I realise this is just a stepping stone to getting this documentation into GitHub.

Yeah. That's annoying. It's an artifact from having some of the list items in a reusable. Could easily be solved with some CSS tweaking, but it's not a priority, as you say.

This seems fine except for the "CodeQL tools" link
https://help.semmle.com/codeql/codeql-tools.html
This gives me a page not found.

Yep. See the comment in the OP. That page will go 'live' tomorrow evening. The updates in this PR are for 1.24, so we'll have plenty of time to test those links.

@jf205
Copy link
Contributor Author

jf205 commented May 5, 2020

@hubwriter: i think this can probably be approved. Over to you.

@shati-patel
Copy link
Contributor

This seems fine except for the "CodeQL tools" link
https://help.semmle.com/codeql/codeql-tools.html
This gives me a page not found.

Yep. See the comment in the OP. That page will go 'live' tomorrow evening. The updates in this PR are for 1.24, so we'll have plenty of time to test those links.

FYI, that page is now live! (The release/publication got pushed forward a bit.)

@jf205 jf205 merged commit 29eed68 into github:rc/1.24 May 7, 2020
@jf205 jf205 deleted the sd-68 branch May 15, 2020 13:43
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.

3 participants