From 2464c43151cd2d64a89973fe0c5ebe60abf48952 Mon Sep 17 00:00:00 2001 From: Jack Heysel Date: Fri, 13 Oct 2023 11:26:19 -0400 Subject: [PATCH 1/2] Update Writing Module Docs to reference msftidy_docs.rb --- .../Writing-Module-Documentation.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/metasploit-framework.wiki/Writing-Module-Documentation.md b/docs/metasploit-framework.wiki/Writing-Module-Documentation.md index 1b821bfc42..572cfc4c47 100644 --- a/docs/metasploit-framework.wiki/Writing-Module-Documentation.md +++ b/docs/metasploit-framework.wiki/Writing-Module-Documentation.md @@ -41,3 +41,18 @@ These are just suggestions, but it'd be nice if the KB had these sections: - **Verification Steps** - Tells users how to use the module and what the expected results are from running the module. - **Options** - Provides descriptions of all the options that can be run with the module. Additionally, clearly identify the options that are required. - **Scenarios** - Provides sample usage and describes caveats that the user may need to be aware of when running the module. + +### Before you submit your PR: msftidy_docs.rb + +A documentation file can be passed as a positional argument to `metasploit-framework/tools/dev/msftidy_docs.rb` and will +highlight formatting errors the docs file might contain. Once all the errors and warnings thrown by msf_tidy_docs have +been resolved, the documentation file is ready for submission. + +``` +➜ metasploit-framework git:(upstream-master) ✗ ruby tools/dev/msftidy_docs.rb documentation/modules/exploit/linux/http/panos_op_cmd_exec.md +documentation/modules/exploit/linux/http/panos_op_cmd_exec.md - [INFO] Missing Section: ## Options +documentation/modules/exploit/linux/http/panos_op_cmd_exec.md - [WARNING] Please add a newline at the end of the file +documentation/modules/exploit/linux/http/panos_op_cmd_exec.md - [WARNING] H2 headings in incorrect order. Should be: Vulnerable Application, Verification Steps/Module usage, Options, Scenarios +documentation/modules/exploit/linux/http/panos_op_cmd_exec.md:50 - [WARNING] Should use single backquotes (`) for single line literals instead of triple backquotes (```) +documentation/modules/exploit/linux/http/panos_op_cmd_exec.md:53 - [WARNING] Spaces at EOL +``` \ No newline at end of file From 4ff3c0f1023e14f33f7e7b06ad8b5a7d890e9216 Mon Sep 17 00:00:00 2001 From: jheysel-r7 Date: Fri, 13 Oct 2023 11:58:01 -0400 Subject: [PATCH 2/2] Update docs/metasploit-framework.wiki/Writing-Module-Documentation.md --- docs/metasploit-framework.wiki/Writing-Module-Documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/metasploit-framework.wiki/Writing-Module-Documentation.md b/docs/metasploit-framework.wiki/Writing-Module-Documentation.md index 572cfc4c47..621068034d 100644 --- a/docs/metasploit-framework.wiki/Writing-Module-Documentation.md +++ b/docs/metasploit-framework.wiki/Writing-Module-Documentation.md @@ -45,7 +45,7 @@ These are just suggestions, but it'd be nice if the KB had these sections: ### Before you submit your PR: msftidy_docs.rb A documentation file can be passed as a positional argument to `metasploit-framework/tools/dev/msftidy_docs.rb` and will -highlight formatting errors the docs file might contain. Once all the errors and warnings thrown by msf_tidy_docs have +highlight formatting errors the docs file might contain. Once all the errors and warnings thrown by `msftidy_docs.rb` have been resolved, the documentation file is ready for submission. ```