Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
db9cef8
commit 25bab01
Showing
1 changed file
with
57 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,62 @@ | ||
| # Documentation is found in the [Wiki](https://github.com/timvideos/getting-started/wiki) repository. | ||
| # TimVideos Developers Website | ||
|
|
||
| You can edit the documentation using the website, or you can clone it with | ||
| ``` | ||
| git clone git@github.com:timvideos/getting-started.wiki.git | ||
| ``` | ||
| ## How to contribute to getting-started website? | ||
|
|
||
| # Don't commit to the base repository! | ||
| Editing content is now very easy on _getting-started_. Website uses power of [**prose content editor**](prose.io) to provide easy interface to edit/add and delete content. | ||
|
|
||
| Make edits to the wiki section (link on the right on github), they should be automatically pushed to the main repo. | ||
| ### If you have ability to push to master repository | ||
|
|
||
| In that case to generate website with your changes you need to commit and push your changes to master repository (you can do it manually, use GitHub editor or Prose editor described below. | ||
|
|
||
| Website will be generated in 1 minute after your commit. If page generation fail, you will receive email from Travis CI. | ||
|
|
||
| ### If you don't have ability to push to master repository | ||
|
|
||
| 1. Fork it ( <https://github.com/timvideos/getting-started/fork> ) | ||
| 2. Create your feature branch (`git checkout -b my-new-feature`) | ||
| 3. Edit content with your favourite content editor (Prose, GitHub, etc.) | ||
| 4. Commit your changes (`git commit -am 'Add some feature'`) | ||
| 5. Push to the branch (`git push origin my-new-feature`) | ||
| 6. Create a new Pull Request | ||
|
|
||
| Website with your changes will be generated after pull request merge. | ||
|
|
||
| ## How to edit existing content? | ||
|
|
||
|  | ||
|
|
||
| Every editable page on **getting-started** has small and red edit icon () on the right top part of editable box. If you click on that link you will be redirected to TimVideos instance of prose editor ([http://editor.timvideos.us](http://editor.timvideos.us)). You can read more about prose editor in [prose/prose](http://github.com/prose/prose) GitHub repository and on [Prose.io Wiki](https://github.com/prose/prose/wiki). | ||
|
|
||
| On the right side of editor you can see 3-5 buttons: | ||
| - **Edit** - if you want to edit content | ||
| - **Preview** - if you want to see realistic preview of your changes | ||
| - **Meta Data** - if you want to edit meta data available for Jekyll (tags, page title, layout, etc.) | ||
| - **Settings** - if you want to change file path or delete file | ||
| - **Save** - if you want to commit your changes. If you click on that button you will see difference between file after and before your changes. | ||
|
|
||
| **Before saving/submiting change request you need to authorize Prose editor. To do that, just go to [http://editor.timvideos.us](http://editor.timvideos.us) and click 'Authorize on GitHub'** | ||
|
|
||
| On the top bar of **Prose** editor you can see few options that are standard in every text editor. | ||
|
|
||
| ## How to add new page to getting-started? | ||
|
|
||
|  | ||
|
|
||
| If you want to add new page to getting-started you need to go to <http://editor.timvideos.us>, select timvideos/getting-started repository or your fork, click on big, green button 'NEW FILE'. | ||
| Select your filename (remember filename is also a path for your page, ie. if you create page named hdmi2usb-history.md, your page will be accessible via http://code.timvideos.us/hdmi2usb-history), on the top of file content add metadata: | ||
| --- | ||
| layout: default | ||
| tags: test | ||
| title: Your title. | ||
| --- | ||
| And add content below, then click on **Save** and after one minute your page will be generated. | ||
|
|
||
| ## Wiki | ||
|
|
||
| Because of **Prose Content Editor** wiki part will not be longer maintained, soon wiki will contain documents related to getting-started repository: technical documentation, etc. | ||
|
|
||
| Editing documentation will not generate website. If you remember old headline in README, now you should learn new one: | ||
|
|
||
| # Commit to the base repository (master branch) if you want to generate website! | ||
|
|
||
| [](http://githalytics.com/github.com/timvideos) |