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

Adding Http Modules Docs #11436

Merged
merged 4 commits into from Feb 19, 2019
Merged

Adding Http Modules Docs #11436

merged 4 commits into from Feb 19, 2019

Conversation

Yashvendra
Copy link
Contributor

Adding auxiliary/scanner/http/http_put and auxiliary/scanner/http/scraper documentation.

@Yashvendra
Copy link
Contributor Author

@bcoles Thanks for the help!

@bcoles bcoles added the docs label Feb 19, 2019
@bcoles
Copy link
Contributor

bcoles commented Feb 19, 2019

Modules should have an ## Options heading which defines the module options.

For the http_put module, you should also describe the different module ACTION values.

Also, the ## Scenarios section should offer vaguely realistic scenarios. For example, for the scraper module, although the PATTERN default is reasonable, it would make sense to show setting the PATTERN anyway, ie:

set PATTERN <title>(.*)</title>

@bcoles bcoles added this to To Do in Module documentation Feb 19, 2019
@bcoles bcoles moved this from To Do to In Review in Module documentation Feb 19, 2019
@Yashvendra
Copy link
Contributor Author

I updated the doc accordingly but one simple question, I should now just replace the old docs with the new docs on my local repo while remaining at http_doc branch and simply just push it again right?

@jrobles-r7
Copy link
Contributor

If you planned on updating this PR, you should be editing the docs while in the http_doc branch.
After editing the docs commit the changes and then push the http_doc branch.

If you modified the docs outside of the http_doc branch then copy the docs to the http_doc branch, commit, and push the http_doc branch.

## Options

### ACTION

Copy link
Contributor

Choose a reason for hiding this comment

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

Consider adding a line here:

Set `ACTION` to either `PUT` or `DELETE`. (default: `PUT`)

documentation/modules/auxiliary/scanner/http/http_put.md Outdated Show resolved Hide resolved
bcoles and others added 2 commits February 19, 2019 14:32
@jrobles-r7 jrobles-r7 self-assigned this Feb 19, 2019
@jrobles-r7 jrobles-r7 merged commit b50b2a7 into rapid7:master Feb 19, 2019
jrobles-r7 added a commit that referenced this pull request Feb 19, 2019
@jrobles-r7
Copy link
Contributor

jrobles-r7 commented Feb 19, 2019

Release Notes

Documentation has been added for the http_put module and scraper auxiliary scanner modules.

msjenkins-r7 pushed a commit that referenced this pull request Feb 19, 2019
@bcoles bcoles moved this from In Review to Done in Module documentation Feb 19, 2019
1. Do: ```use auxiliary/scanner/http/scraper```
2. Do: ```set RHOSTS [IP]```
3. Do: ```run```

Copy link
Contributor

Choose a reason for hiding this comment

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

This is missing a ## Options section, where you'd mention the PATTERN and call out the default instead of putting it in the scenarios section.

@Yashvendra Yashvendra mentioned this pull request Feb 21, 2019
@gdavidson-r7 gdavidson-r7 added the rn-enhancement release notes enhancement label Mar 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs rn-enhancement release notes enhancement
Development

Successfully merging this pull request may close these issues.

None yet

5 participants