Contributing to KB
Contributing to this KB is simple and the following really simple steps should be able to let you write your own articles and report them properly to the other developers as well as anyone who wishes to read your articles.
For contributing to this KB, you need to be one of the Community team members in this organization. This is the most open team in the organization, and everyone who joins us is a part of Community at the very least. If you are not a part already, contact one of the Community team members and they will grant you access. Once you are a team member, you can add new pages to the wiki.
Once the following button is visible to you as follows, you can create a new page or modify an existing one to suit your report your findings.
Once, the page is written to or modified, you would want to add an "Edit Message" and save the page.
If your page needs some images to be added, read the following article: Adding images to Wiki - Github. We use the images hosted on the repository itself. So, for adding your images,
- Clone the repository using
git clone https://github.com/IOStream-OpenEnd/knowledgeBase.git - In the local repository, under
assets, add your image file. Try keeping up with naming conventions in the repo, and use meaningful filenames. - Push your local changes (added images) to remote.
- Link your images in the articles using hyperlink (
[[https://github.com/username/repository/blob/master/img/octocat.png|alt=octocat]])
If you have created a new page, you might consider adding your page in appropriate hierarchial structure. Click on the pencil icon (edit) on the sidebar and edit the sidebar (use 4 spaces for sublist). Use following link structure:
[Hyperlink title](hyperlink).
That's all there is to it. Ping the other developers if you need any help.