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

Add Documents, Improve Wiki, Add Training Videos #1

Closed
Ali-Razmjoo opened this issue Aug 27, 2017 · 15 comments
Closed

Add Documents, Improve Wiki, Add Training Videos #1

Ali-Razmjoo opened this issue Aug 27, 2017 · 15 comments

Comments

@Ali-Razmjoo
Copy link
Collaborator

Hello everyone,

OWASP Nettacker doesn't have any documents or wiki right now, It's best we start Developers/Users documents to make it more friendly.

I glad if anyone can help on this! (start from wiki)

@Ali-Razmjoo Ali-Razmjoo changed the title Add Documents and Complete Wiki Add Documents, Improve Wiki, Add Training Videos Jan 11, 2018
@Ali-Razmjoo
Copy link
Collaborator Author

Hi,

I just improved the wiki a little bit. but still, it needs really many things to add. adding training videos for users and developers would be great!

Regards.

@Ali-Razmjoo Ali-Razmjoo self-assigned this Jan 14, 2018
Ali-Razmjoo pushed a commit that referenced this issue Jan 15, 2018
must be added to documents #1
Ali-Razmjoo pushed a commit that referenced this issue Jan 18, 2018
#1 docs should be add later
@Ali-Razmjoo
Copy link
Collaborator Author

Hello,

I made the first GIF demo with simple commands. If anyone would like to help here, I'll glad to receive more videos/gif/documents.

2018-01-19_0-45-07

Regards.

Ali-Razmjoo pushed a commit that referenced this issue Jan 24, 2018
submit a new scan API finished, start() function of all modules changed, documents must be update #1
Ali-Razmjoo pushed a commit that referenced this issue Feb 1, 2018
Ali-Razmjoo pushed a commit that referenced this issue Feb 3, 2018
@Tikam02
Copy link
Contributor

Tikam02 commented Feb 16, 2018

@Ali-Razmjoo i would like to contribute and make a readthedocs documentation and wiki pages for Nettacker.

@Ali-Razmjoo
Copy link
Collaborator Author

Hello,

Probably I should work on them to write the first version of documents, after that, you may contribute for corrections, update, video tutorials and etc.

Best Regards.

@ThorodanBrom
Copy link

ThorodanBrom commented Feb 20, 2018

@Ali-Razmjoo what have you used to make the GIFs? I was going to try it our myself, and am thinking of using asciinema

@Tikam02
Copy link
Contributor

Tikam02 commented Feb 20, 2018

If using kali Linux there is already a built-in video recording plugin, and ubuntu also has lots of video and gif creators apps.

Ali-Razmjoo pushed a commit that referenced this issue Feb 23, 2018
Ali-Razmjoo pushed a commit that referenced this issue Feb 24, 2018
Ali-Razmjoo pushed a commit that referenced this issue Feb 24, 2018
@Ali-Razmjoo
Copy link
Collaborator Author

Hello,

@ThorodanBrom asciinema is also a great thing for making tutorials. I made them with snagit on windows. there are several tools for any OS. let me know if you need more information, just share us more details.

@Tikam02 thank you for guides

Regards.

@Ali-Razmjoo
Copy link
Collaborator Author

Hey, thanks to @pradeepjairamani

new gif - api usage.
output_pmq3sj

regards.

@pradeepjairamani
Copy link
Contributor

webp net-gifmaker 1

New giif - Wizard usage

@Ali-Razmjoo
Copy link
Collaborator Author

Hey @Tikam02,

The wiki is almost done, let me know if you would like to work on readthedocs.

Regards.

@Ali-Razmjoo
Copy link
Collaborator Author

Hello,

I've updated the wiki, feel free to contribute and send your feedbacks.

Best Regards.

@Tikam02
Copy link
Contributor

Tikam02 commented Apr 23, 2018

Yeah, sure wiki page looks great.I'll contribute if I get any new ideas or get any new challenge while using it.

@cwcromwell
Copy link

I'd like to contribute to the documentation. Would anyone mind if I edited the wiki? I could perform a line edit for spelling, grammar and punctuation. And I could also look for any issues with readability and usability.

my LinkedIn:
https://www.linkedin.com/in/clarence-cromwell-2279a614/

Thanks,
Clarence

@Ali-Razmjoo
Copy link
Collaborator Author

@cwcromwell thanks for beginning interested and helping this project, it's a pleasure and we appreciate any help. I sent you an email for farther discussion.

@psahithireddy
Copy link

Hello,
A few links aren't redirecting correctly. For example,

  1. In Home.md, wiki and github links aren't redirecting correctly.
  2. Issues link in Developers.md
  3. Missing Issue Template and PR Template in Developers.md.

I edited 1 and 2 on my end, but the wiki changes aren't detected in the fork in order to submit a PR.

Thanks,
Sahithi

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants