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

To be merged for 7.1 - MTA-3848: MTA flags are missing in the documentation #69

Open
wants to merge 25 commits into
base: main
Choose a base branch
from

Conversation

anarnold97
Copy link
Collaborator

@anarnold97 anarnold97 commented Nov 3, 2024

JIRA

PREVIEW

While fixing a build problem, I found an open block comment that had removed the following section of documentation. Is it required (including amended) or is it to be removed?

@anarnold97 anarnold97 changed the title WIP - MTA-4161: MTA flags are missing in the documentation WIP - MTA-3848: MTA flags are missing in the documentation Nov 6, 2024
Copy link
Collaborator

@ibragins ibragins left a comment

Choose a reason for hiding this comment

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

Can we do a list of technology tags expandable? It takes a long time to scroll through this list :-)

@anarnold97
Copy link
Collaborator Author

@ibragins - I am not sure what you mean by "technology tags expandable", do you mean a collapsible block

In which case YEAH OF COURSE:

[%collapsible]
====
This content is only revealed when the user clicks the block title.
====

it is like i know what i am doing sometimes

@ibragins
Copy link
Collaborator

@anarnold97 sorry, I meant collapsible block. And didn't want to offend you in any way.

@anarnold97
Copy link
Collaborator Author

@ibragins - no worries,
laughing so hard, i snarfed my coffee.

@ibragins
Copy link
Collaborator

ibragins commented Nov 11, 2024

Take care @anarnold97 , and don't damage your laptop with your coffee :-D

docs/topics/mta-cli-args.adoc Outdated Show resolved Hide resolved
docs/topics/mta-cli-args.adoc Outdated Show resolved Hide resolved
Copy link

@aufi aufi left a comment

Choose a reason for hiding this comment

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

Gave it a quick look with few comments.

Note, current flags (for 7.2.0) of the CLI tool should be following:

kantra$ go run main.go analyze --help
Analyze application source code

Usage:
  kantra analyze [flags]

Flags:
      --analyze-known-libraries             analyze known open-source libraries
      --bulk                                running multiple analyze commands in bulk will result to combined static report
      --context-lines int                   number of lines of source code to include in the output for each incident (default 100)
  -d, --dependency-folders stringArray      directory for dependencies
      --enable-default-rulesets             run default rulesets with analysis (default true)
  -h, --help                                help for analyze
      --http-proxy string                   HTTP proxy string URL
      --https-proxy string                  HTTPS proxy string URL
      --incident-selector string            an expression to select incidents based on custom variables. ex: (!package=io.konveyor.demo.config-utils)
  -i, --input string                        path to application source code or a binary
      --jaeger-endpoint string              jaeger endpoint to collect traces
      --json-output                         create analysis and dependency output as json
  -l, --label-selector string               run rules based on specified label selector expression
      --list-providers                      list available supported providers
      --list-sources                        list rules for available migration sources
      --list-targets                        list rules for available migration targets
      --maven-settings string               path to a custom maven settings file to use
  -m, --mode string                         analysis mode. Must be one of 'full' (source + dependencies) or 'source-only' (default "full")
      --no-proxy string                     proxy excluded URLs (relevant only with proxy)
  -o, --output string                       path to the directory for analysis output
      --override-provider-settings string   override the provider settings, the analysis pod will be run on the host network and no providers will be started up
      --overwrite                           overwrite output directory
      --provider stringArray                specify which provider(s) to run
      --rules stringArray                   filename or directory containing rule files. Use multiple times for additional rules: --rules <rule1> --rules <rule2> ...
      --run-local                           run analysis directly on local system without containers (for Java and Maven)
      --skip-static-report                  do not generate static report
  -s, --source stringArray                  source technology to consider for analysis. Use multiple times for additional sources: --source <source1> --source <source2> ...
  -t, --target stringArray                  target technology to consider for analysis. Use multiple times for additional targets: --target <target1> --target <target2> ...

Global Flags:
      --log-level uint32   log level (default 4)
      --no-cleanup         do not cleanup temporary resources

@anarnold97
Copy link
Collaborator Author

--run-local run analysis directly on local system without containers (for Java and Maven)
--skip-static-report do not generate static report

@ibragins & @aufi - have updated?

Please can you review again?

And please can I also clarify which flags are excluded from 7.1

Thanks

@anarnold97
Copy link
Collaborator Author

@ibragins & @aufi - please can i give you a nudge to review?
Also, please you advise on the differences in flags between 7.1 & 7.2
Thanks

Copy link

@aufi aufi left a comment

Choose a reason for hiding this comment

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

LGTM

@aufi
Copy link

aufi commented Nov 20, 2024

For diff, check konveyor/kantra@release-0.5...release-0.6 and focus on files in cmd directory.

For analyze:
image

But depends if the previous release docs were up-to-date.

@anarnold97
Copy link
Collaborator Author

@aufi - thanks very much

My aim is to publish this to deal with the outdated docs for 7.1 and then create a second PR for 7.2 if needed. The currently available docs are out-of-date.

If I publish today will this cover 7.1, and then do i need to republish for 7.2?

FYI @ibragins

@anarnold97
Copy link
Collaborator Author

@ibragins - please could you do a review, when you have a chance?

as i would like to get it merged for 7.1 ASAP

Copy link
Collaborator

@ibragins ibragins left a comment

Choose a reason for hiding this comment

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

LGTM

====

////
[id="cli-packages-argument_{context}"]
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@istein1 - section on Packages removed here
This only leaves three references of --packages to resolve for MTA-4220

Copy link

@aufi aufi left a comment

Choose a reason for hiding this comment

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

👍


| -s, --source string
| source technology to consider for analysis. To specify multiple sources, repeat the parameter: --source <source_1> --source <source_2> etc.
a|`--run-local`
Copy link

Choose a reason for hiding this comment

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

Just note, this is default true in 7.2, can be disabled with --run-local=false.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Damn it! Will have to do a second PR for that

@anarnold97 anarnold97 changed the title WIP - MTA-3848: MTA flags are missing in the documentation To be merged for 7.1 - MTA-3848: MTA flags are missing in the documentation Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants