Skip to content

Code QL pre-migration tasks: update articles relating to CodeQL for JavaScript#2897

Merged
mchammer01 merged 10 commits intogithub:docs-preparationfrom
mchammer01:js-migration-work
Mar 6, 2020
Merged

Code QL pre-migration tasks: update articles relating to CodeQL for JavaScript#2897
mchammer01 merged 10 commits intogithub:docs-preparationfrom
mchammer01:js-migration-work

Conversation

@mchammer01
Copy link
Copy Markdown
Contributor

@mchammer01 mchammer01 commented Feb 21, 2020

See https://github.com/github/product-documentation/issues/2165 for details.
The first commit changes titles.

@mchammer01
Copy link
Copy Markdown
Contributor Author

2nd commit adds some intros but I'm afraid I won't get much further before we have to leave for the mini-summit.

@mchammer01
Copy link
Copy Markdown
Contributor Author

Please note that I haven't made any changes to do with content models and localization checklists.

Comment thread docs/language/learn-ql/javascript/introduce-libraries-js.rst Outdated
Comment thread docs/language/learn-ql/javascript/introduce-libraries-ts.rst Outdated
Comment thread docs/language/learn-ql/javascript/type-tracking.rst
@mchammer01
Copy link
Copy Markdown
Contributor Author

mchammer01 commented Feb 25, 2020

Thanks for the valuable review @intrigus-lgtm 👍
This PR has been raised as a draft so I wasn't expecting reviews just yet 😉
It's just a starting point and I have a lot more work to do but I'll ensure I'll take your comments (especially the ones about the typos 😱 ) into consideration.
Our documentation is written in American English but I know that we need to rationalize spellings and check that this is true throughout the whole set of articles. This work is part of the migration of the CodeQL documentation and has just started so please bear with us while we improve things.
Thanks again for your help!

@mchammer01 mchammer01 marked this pull request as ready for review March 5, 2020 10:36
@mchammer01
Copy link
Copy Markdown
Contributor Author

mchammer01 commented Mar 5, 2020

This PR is now ready for review.
The work in this PR contains pre-migration tasks for the CodeQL documentation. This includes:

  • updating article titles
  • adding intros to each article
  • updating links as per the new article title
  • change the What next section title to Further reading

@mchammer01
Copy link
Copy Markdown
Contributor Author

mchammer01 commented Mar 5, 2020

Apologies for the automatic review request @jf205 and @shati-patel but I can't seem to be able to remove that (no cog icon for me to the right of the Reviewers section on the right hand-side). Is this due to a permissions thing on this repo?

@felicitymay
Copy link
Copy Markdown
Contributor

Since this is small text changes, I'm removing @jf205 ad @shati-patel as reviewers. Anyone in the docs team can review this PR.

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.

Thanks for the update. The new titles and associated changes to links look good.

Could you review the introductions? I'm not sure all articles have one (probably because you were interrupted in the middle of this work).

Comment thread docs/language/learn-ql/javascript/introduce-libraries-ts.rst Outdated
Comment thread docs/language/learn-ql/javascript/type-tracking.rst
Comment thread docs/language/learn-ql/javascript/type-tracking.rst Outdated
mchammer01 and others added 3 commits March 6, 2020 08:17
@mchammer01
Copy link
Copy Markdown
Contributor Author

@felicitymay - thanks for your review. I believe I have addressed your comments.
I am keen to get this merged today, as discussed in our team meeting.
We can still iterate if there are further things to tweak or rationalize between languages.

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.

Thanks for the additional introductions. A couple of very minor suggestions. Ready to merge once you've accepted/rejected those suggestions.

Comment thread docs/language/learn-ql/javascript/type-tracking.rst Outdated
Comment thread docs/language/learn-ql/javascript/dataflow-cheat-sheet.rst Outdated
mchammer01 and others added 2 commits March 6, 2020 10:50
Co-Authored-By: Felicity Chapman <felicitymay@github.com>
Co-Authored-By: Felicity Chapman <felicitymay@github.com>
@mchammer01
Copy link
Copy Markdown
Contributor Author

@felicitymay - I have accepted your suggestions. Can you double-check you are ok with things now? Thanks.

@felicitymay
Copy link
Copy Markdown
Contributor

All LGTM 💚

@mchammer01 mchammer01 merged commit 2c542df into github:docs-preparation Mar 6, 2020
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