Skip to content

Commit

Permalink
Contributing to the wiki (#99)
Browse files Browse the repository at this point in the history
* fixing home issue

Signed-off-by: Elisa Capololo <[email protected]>

* additional content contributing to the wiki

Signed-off-by: Elisa Capololo <[email protected]>

---------

Signed-off-by: Elisa Capololo <[email protected]>
  • Loading branch information
ElisaCapololo authored Jan 23, 2024
1 parent 2bd041d commit d66a6cb
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 2 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,53 @@ $ git pull upstream master
$ git push origin master
```

# Contributing to the wiki
## Adding or editing wiki pages

You can add and edit wiki pages directly on GitHub or locally using the command line.

Wikis are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see [GitHub’s plans.](https://docs.github.com/en/get-started/learning-about-github/githubs-plans)

## Adding wiki pages
1. On GitHub.com, navigate to the main page of the repository.
2. Under your repository name, click **Wiki**.
![wiki](https://docs.github.com/assets/cb-50195/mw-1440/images/help/wiki/wiki-menu-link.webp)
3. In the upper-right corner of the wiki, click **New Page**.
4. Optionally, to write in a format other than Markdown, use the "Edit mode" dropdown to choose a different format.
![Edit mode](https://docs.github.com/assets/cb-109300/mw-1440/images/help/wiki/wiki-edit-mode-dropdown.webp)
5. Use the text editor to add your page's content.
6. In the "Edit message" field, type a commit message describing the new file you’re adding.
7. To commit your changes to the wiki, click Save Page.

## Editing wiki pages
1. On GitHub.com, navigate to the main page of the repository.
2. Under your repository name, click **Wiki**.
![wiki](https://docs.github.com/assets/cb-50195/mw-1440/images/help/wiki/wiki-menu-link.webp)
3. Using the wiki sidebar on the right, navigate to the page you want to change. In the upper-right corner of the page, click **Edit**.
4. Use the text editor to edit the page's content.
5. In the "Edit message" field, type a commit message describing the new file you’re adding.
6. To commit your changes to the wiki, click **Save Page**.


## Adding or editing wiki pages locally
Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow.

### Cloning wikis to your computer
Every wiki provides an easy way to clone its contents down to your computer. Once you've created an initial page on GitHub, you can clone the repository to your computer with the provided URL:

```
$ git clone https://github.com/chaoss/chaoss-slack-bot.wiki.git
# Clones the wiki locally
```
Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers.

## About wiki
The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered.

Wikis use our [open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file foo.md or foo.markdown, wiki will use the Markdown converter, while a file named foo.textile will use the Textile converter.

Don't use the following characters in your wiki page's titles: ```\ / : * ? " < > |```. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly.

# Community Resources
## CHAOSS
- [Website](https://chaoss.community/)
Expand Down
5 changes: 3 additions & 2 deletions Translations/Portuguese/Home.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
This is the link to the slack bot wiki homepage to be translated.
[Home](https://github.com/chaoss/chaoss-slack-bot/wiki)
# Bem-vindo ao wiki do chaoss-slack-bot 🎉
Chaoss Slack Bot é um aplicativo Slack que dá as boas-vindas aos recém-chegados à comunidade CHAOSS Slack. Ele foi construído usando a estrutura [Bolt para JavaScript](https://github.com/SlackAPI/bolt-js).
![CHAOSS Slack Bot](https://user-images.githubusercontent.com/71160347/203390508-12570ffb-65b8-445a-99d6-a9d142b8a916.png)

0 comments on commit d66a6cb

Please sign in to comment.