Systers Community

Prepare a document explaining the most effective wiki sidebar format.

Prerequisite:

  • Research multiple open source organizations' GitHub Wiki formats.

Steps:

  • List all of the GitHub Wikis that you researched.
  • Number them from 1 to n (n being the number of GitHub Wikis you researched) from the most effective to the least effective.
  • Explain why you like or dislike the format, then explain why or how the GitHub Wiki was effective.
  • Answer the following questions:
    • Which Wiki format was easiest to understand?
    • Did any project or repo give instructions to non-technical contributors?
    • Which sidebar menu was most detailed?
    • What do you think is absolutely needed for every GitHub Wiki? Why?
  • Prepare a Google doc including all of the research above about the Wiki sidebar menu, content, and format.

Resources:

  • This is a really good example of one sidebar
  • Ask any questions or directions in the #systers or #questions on Systers Open Source Slack. Mention @paavini, @manasvi.duggal, or @divyapandilla if you need directions on this task.

Work Submission:

Submit the link to the Google doc.

Task tags

  • wiki
  • documentation
  • github
  • sidebar
  • research

Students who completed this task

Fidella, Rosemarie van de Ven

Task type

  • chrome_reader_mode Documentation / Training
close

2017