Skip to content

Conversation

@ISnackable
Copy link

Update the docs to include new options released with CodeQL CLI 2.5.6 See here.

I did not see this option being documented anywhere in CodeQL docs. This option should actually be documented in https://codeql.github.com/docs/codeql-cli/manual/database-create/ but I could not find the file for codeql-cli manual in this repo.

Hopefully the team can add this option to the manual page.

The Sphinx output for this change look like this:
image

I'm not sure whether this option should be documented to this page, feel free to close/make changes to this PR.

@jf205
Copy link
Contributor

jf205 commented Jul 19, 2021

@ISnackable thanks for opening this PR. I'm going to hand this over to the docs team to review!

I did not see this option being documented anywhere in CodeQL docs. This option should actually be documented in https://codeql.github.com/docs/codeql-cli/manual/database-create/ but I could not find the file for codeql-cli manual in this repo.

https://codeql.github.com/docs/codeql-cli/manual/database-create/ is generated content that should have been updated when the CLI was released. It doesn't seem to have been updated for 2.5.7. Perhaps someone on the docs team can check that for us please?

@jf205 jf205 added the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Jul 19, 2021
@shati-patel
Copy link
Contributor

https://codeql.github.com/docs/codeql-cli/manual/database-create/ is generated content that should have been updated when the CLI was released. It doesn't seem to have been updated for 2.5.7. Perhaps someone on the docs team can check that for us please?

👋🏽 Thanks for bringing this to our attention, @ISnackable!

Since --overwrite is an advanced flag with potential unexpected consequences, we didn't want to encourage its use. However, we've now made the documentation visible, so it should appear in https://codeql.github.com/docs/codeql-cli/manual/database-create for one of the upcoming CLI releases 🎉 (Probably the next one after 2.5.8)

I'll close this PR, since it's an internal change, but thank you again for raising this! 😃

@shati-patel shati-patel removed the ready-for-doc-review This PR requires and is ready for review from the GitHub docs team. label Jul 21, 2021
@ISnackable
Copy link
Author

ISnackable commented Jul 21, 2021

@shati-patel I forgotten to mention this but the --overwrite option should also be documented for the database init page. Thank you!

@ISnackable ISnackable deleted the ISnackable-patch-1 branch July 21, 2021 08:51
@shati-patel
Copy link
Contributor

@shati-patel I forgotten to mention this but the --overwrite option should also be documented for the database init page. Thank you!

Just double-checked—it will appear there too. Thanks! ✨

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