Skip to content

CodeQL docs: update titles, add intros, and a few content updates (CodeQL for C/C++)#2869

Merged
jf205 merged 4 commits intogithub:docs-preparationfrom
jf205:codeql-migration-2163
Mar 11, 2020
Merged

CodeQL docs: update titles, add intros, and a few content updates (CodeQL for C/C++)#2869
jf205 merged 4 commits intogithub:docs-preparationfrom
jf205:codeql-migration-2163

Conversation

@jf205
Copy link
Copy Markdown
Contributor

@jf205 jf205 commented Feb 19, 2020

The PR makes a start at addressing the tasks in https://github.com/github/product-documentation/issues/2163.

tldr for any members of the C analysis team who stumble upon this: We are trying to align the CodeQL documentation with the style and structure used in the GitHub help docs. There will be a series of PRs with updates. We'll try not to do anything that could change the technical meaning of the text and may ping you with questions as we are going along.

Summary of changes

  • Update titles
  • Update links to account for new titles
  • Add intros
  • Rework the CodeQL for C and C++ homepage to include only the autogenerated TOC.
  • Some small changes to content:
    • Attempt to make the flow from the new intro to the main article a bit smoother
    • Fix a few inline links

TODO

Possibly next PR:

Later PRs:

  • Think long and hard about the most appropriate content models to apply.
  • Review content, adding referential, conceptual, and procedural sections in certain topics.

For more info, see notes on https://github.com/github/product-documentation/issues/2163.

@jf205 jf205 requested a review from shati-patel as a code owner February 19, 2020 11:24
@jf205 jf205 added documentation migration-prep WIP This is a work-in-progress, do not merge yet! labels Feb 19, 2020
@jf205 jf205 removed the request for review from shati-patel February 19, 2020 11:33
Copy link
Copy Markdown
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

These changes all look good. I wonder if a couple of the introductions really add much to the title, but haven't commented because the PRs we've opened so far all view this differently. This is something that it would be good to discuss as a group - topics like the library introductions should probably have fairly similar introductions.

NOTE: You can find related classes and features using the query console's auto-complete feature. You can also press *F3* to jump to the definition of any element; library files are opened in new tabs in the console.
.. pull-quote:: Note

You can find related classes and features using the query console's auto-complete feature. You can also press *F3* to jump to the definition of any element. Library files are opened in new tabs in the console.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not required for this PR, but this note should probably have been deleted or clarified when we moved the documentation out of LGTM. We should probably check other languages for similar notes.

Comment thread docs/language/learn-ql/cpp/private-field-initialization.rst Outdated
Copy link
Copy Markdown
Contributor

@shati-patel shati-patel 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 overall! (I've just made some suggestions to use the exact title when linking.)

I agree that we need to decide on more consistent intros (and possibly titles) across the languages. @felicitymay is making notes on these kind of tasks, so we can discuss that as a group later.

Comment thread docs/language/learn-ql/cpp/private-field-initialization.rst Outdated
Comment thread docs/language/learn-ql/cpp/value-numbering-hash-cons.rst Outdated
Comment thread docs/language/learn-ql/cpp/zero-space-terminator.rst Outdated
Co-Authored-By: Felicity Chapman <felicitymay@github.com>
Co-Authored-By: Shati Patel <42641846+shati-patel@users.noreply.github.com>
@jf205 jf205 force-pushed the codeql-migration-2163 branch from 389cc14 to b1a2470 Compare March 10, 2020 11:40
@jf205
Copy link
Copy Markdown
Contributor Author

jf205 commented Mar 10, 2020

@shati-patel, @felicitymay: thanks for the comments and suggestions. Is there anything else you think I should address now? (I intend to revisit this when all of the other initial 'CodeQL for X' PRs have been completed, as mentioned on #2866 and #2823.)

@felicitymay
Copy link
Copy Markdown
Contributor

Thanks for the updates 👍

@jf205 jf205 removed the WIP This is a work-in-progress, do not merge yet! label Mar 11, 2020
@jf205
Copy link
Copy Markdown
Contributor Author

jf205 commented Mar 11, 2020

I removed the WIP label now. Any further thoughts before i merge?

@felicitymay
Copy link
Copy Markdown
Contributor

I think this is fine to merge as-is.

@jf205 jf205 merged commit 554981e into github:docs-preparation Mar 11, 2020
@jf205 jf205 changed the title CodeQL docs: update titles, add intros, and a few content updates CodeQL docs: update titles, add intros, and a few content updates (CodeQL for C/C++) Mar 12, 2020
@jf205 jf205 deleted the codeql-migration-2163 branch April 2, 2020 07:02
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