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.

Sign up for GitHub

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

Jump to bottom

[#1404] DG: edit the running from code part #1405

Merged
merged 7 commits into from
Feb 7, 2021
Merged

[#1404] DG: edit the running from code part #1405

merged 7 commits into from
Feb 7, 2021

Conversation

HCY123902
Copy link
Contributor

@HCY123902 HCY123902 commented Jan 16, 2021 •
edited

Resolves #1404

Commit message

Edit the running from code section of the Developer Guide

The documentation does not specifically mention how to view the
report in the browser when running the application from code.

Adding the additional documentation can bring convenience for
newcomers to run the application locally when developing.

Let's edit the documentation to make the instructions clearer.

@HCY123902 HCY123902 requested a review from a team January 16, 2021 15:26
@HCY123902 HCY123902 assigned HCY123902 and unassigned HCY123902 Jan 16, 2021
@HCY123902 HCY123902 changed the title Edit the running from code documentation [#1404] Edit the running from code documentation Jan 17, 2021
Tejas2805
Tejas2805 reviewed Jan 17, 2021
View reviewed changes
docs/dg/workflow.md Outdated
e.g., `gradlew run -Dargs="--since 31/12/2019 --formats java adoc xml"`
* Run `gradlew run -Dargs="--view ./reposense-report"` to view the generated report in the default browser.
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure about this but do we need to have the ./reposense-report part? Isn't that the default?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for pointing it out. It is the default. I have edited it accordingly.

Tejas2805
Tejas2805 approved these changes Jan 23, 2021
View reviewed changes
Copy link
Contributor

@Tejas2805 Tejas2805 left a comment

Choose a reason for hiding this comment

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

LGTM!

@Tejas2805 Tejas2805 requested a review from a team January 24, 2021 14:50
@fzdy1914 fzdy1914 changed the title [#1404] Edit the running from code documentation [#1404] DG: edit the running from code part Jan 26, 2021
@fzdy1914
Copy link
Member

The documentation does not specifically mention how to view the
report in the browser when running the application from code.

Adding the additional documentation can bring convenience for
newcomers to run the application locally when developing.

Let's edit the documentation to make the instructions clearer.

@Tejas2805
Copy link
Contributor

@HCY123902 Can you update the commit message based on the comment by @fzdy1914 ?

@HCY123902
Copy link
Contributor Author

HCY123902 commented Jan 31, 2021 •
edited

Sure, no problem

@fzdy1914 fzdy1914 merged commit 973817c into reposense:master Feb 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fzdy1914 fzdy1914 fzdy1914 approved these changes

@Tejas2805 Tejas2805 Tejas2805 approved these changes

Assignees
No one assigned
Labels
a-Docs s.ToMerge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update the documentation for running RepoSense from code
3 participants
@HCY123902 @fzdy1914 @Tejas2805