Skip to content

Conversation

@Ruchip16
Copy link

Pull Request Template

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Additional Context (Please include any Screenshots/gifs if relevant)

...

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings
  • I have tagged the reviewers in a comment below incase my pull request is ready for a review
  • I have signed the commit message to agree to Developer Certificate of Origin (DCO) (to certify that you wrote or otherwise have the right to submit your contribution to the project.) by adding "--signoff" to my git commit command.

Copy link
Member

@HarshCasper HarshCasper left a comment

Choose a reason for hiding this comment

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

Please rename the PR to Add Operation Guide for Reporting Tool and see if you missed the actual doc pieces.

Comment on lines +1 to +3
{
"python.pythonPath": "docs\\env\\Scripts\\python.exe"
} No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

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

I don't see the particular use-case of this here

Copy link
Author

@Ruchip16 Ruchip16 Sep 26, 2021

Choose a reason for hiding this comment

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

no this was for the installation part I need to set the virtual environment for that it needed this in windows

image


We will explore each of these steps in detail in the sections that

follow No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

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

This documentation piece seems incomplete. Is that intentional or is this PR WIP?

Copy link
Author

Choose a reason for hiding this comment

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

ya like in the doc file of operation guide it was concluded like this & I had no idea of what should I put next as there was a lot of stuff which was to be added after this

and also I did not initiate the make clean && make HTML command as I was not sure about this so once you approve I would make another PR containing the final commit

@Tonnix
Copy link
Contributor

Tonnix commented Sep 28, 2021

Hi @Ruchip16 , @HarshCasper This is still WIP?

@HarshCasper
Copy link
Member

Hi @Ruchip16 , @HarshCasper This is still WIP?

Yes. I will ping you once the PR is done and approved from my side.

Signed-off-by: Ruchip16 <[email protected]>
@Ruchip16 Ruchip16 changed the title Ruchi-Added index.rst file into the operation guide folder Ruchi-Added index.rst file Sep 28, 2021
@Ruchip16 Ruchip16 changed the title Ruchi-Added index.rst file Add index.rst file Sep 28, 2021
@Ruchip16
Copy link
Author

@HarshCasper I have rebased my previous commit with the latest one and pushed the changes

@Ruchip16 Ruchip16 changed the title Add index.rst file Add operation guide for reporting tool Oct 28, 2021
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.

3 participants