Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Normalizing file names

  • Loading branch information...
commit a65e830486780bc306c9ba9a4aa9a312c21bc31f 1 parent cfd3ddc
@pelegri pelegri authored
View
40 Community_Wiki.md
@@ -11,10 +11,8 @@ The BlackBerry® Community Wiki is authored collectively by the BlackBerry co
#### Pages
-Pages are short, usually one screenful, overviews of components, technology, or any other topic.
+Pages are short overviews of components, technology, or any other topic.
The goal of these pages is to point the reader to the right place where to get more detailed information.
-Whenever possible we will want to avoid duplicating information readily available elsewhere.
-
See [All Pages].
#### Articles
@@ -29,33 +27,31 @@ Slides from different presentations by RIM and non-RIM employees. See [All Pres
Short news on activities related to BlackBerry Development, with an emphasis on Open Source. See [All News].
-## Contributions
+#### Other
-Your contributions and feedback are critical to the success of this Wiki. Details on how to contribute are available at
-the following pages
-* [Quick Edits](other/QuickEdit.html)
-* [How To Contribute](other/Contribute.html)
-* [How to Submit News](news/Submit_News.html)
+A final set of pages documents the [Operation and Technology](other/index.html) of the Wiki.
-## Work in Progress
-As most wikis, this one is very much *Work In Progress* in all fronts, not just the actual content of a given
-page but also topics covered, level of detail and format.
+## Contributions
+
+Your contributions and feedback are critical to the success of this Wiki; read more details in
+[How To Contribute](other/Contribute.html).
-The location of this wiki and the technology it uses may change over time, but the content and the contribution
-structure will remain the same.
+## Wiki Technology
-## Under the Covers
+The location of this wiki and the technology it uses may change over time. If and when a change happens, we will migrate the
+content to the new location and infrastructure.
-The BlackBerry® Community Wiki uses [GitHub Pages](http://help.github.com/pages/)
-mostly written in [Markdown](http://daringfireball.net/projects/markdown/)
-with templating provided via [Jekyll](http://github.com/mojombo/jekyll/).
-The benefits of this approach over GitHub’s Wiki are [discussed here](http://supportforums.blackberry.com/t5/General-Open-Source-Topics/Community-Wiki-at-GitHub-Pages-or-Wiki/td-p/1466637).
+The current instance of this Wiki uses [GitHub Pages](http://help.github.com/pages/)
+using [Markdown](http://daringfireball.net/projects/markdown/)
+and [Jekyll](http://github.com/mojombo/jekyll/).
+The benefits of this approach are discussed
+[here](http://supportforums.blackberry.com/t5/General-Open-Source-Topics/Community-Wiki-at-GitHub-Pages-or-Wiki/td-p/1466637).
-We use two main repositories: [one](http://github.com/blackberry/Community)
-corresponds to the [released Wiki](http://blackberry.github.com/Community)
+There are two main repositories: [one](http://github.com/blackberry/Community)
+for the [released Wiki](http://blackberry.github.com/Community)
and the [other](http://github.com/blackberry-community/Community)
-corresponds to the [staged Wiki](http://blackberry-community.github.com/Community).
+for the [staged Wiki](http://blackberry-community.github.com/Community).
## Terms and Conditions
View
18 _includes/default-navigation.html
@@ -4,7 +4,6 @@
<ul>
<li><a href="{{ base-url }}/Community_Wiki.html">Home</a></li>
<li><a href="http://www.google.com/#hl=en&q=site%3Ablackberry.github.com%2FCommunity" target="_blank">Search Wiki</a></li>
- <li><a href="http://www.blackberryjamworldtour.com/">Jam World Tour</a></li>
</ul>
</li>
<li>Page and Articles
@@ -29,11 +28,18 @@
<li>Contribute
<ul>
<li><a href="{{ site.stage }}{{ page.url | replace:'.html','.md' }}" target="_blank">Edit Page</a>
- (<a href="{{ base-url }}/other/QuickEdit.html">How?</a>)</li>
- <li><a href="https://github.com/blackberry/Community/issues?labels=pagewanted&milestone=&state=">Propose Page</a>
- (<a href="{{ base-url }}/other/ProposeNewPage.html" target="_blank">How?</a>)</li>
- <li><a href="{{ base-url }}/news/Submit_News.html" target="_blank">Submit News</a></li>
- <li><a href="{{ base-url }}/other/Contribute.html">More Contributions</a></li>
+ [<a href="{{ base-url }}/other/Quick_Edit.html" target="_blank" style="font-size: 100%; font-weight: bold;" title="How to Edit this Page in your Browser">?</a>]
+ </li>
+ <li><a href="https://github.com/blackberry-community/Community">Create Page</a>
+ [<a href="{{ base-url }}/other/Create_New_Page.html" target="_blank" style="font-size: 100%; font-weight: bold;" title="Why You need your Own Fork; and How to get it">?</a>]
+ </li>
+ <li><a href="https://github.com/blackberry/Community/issues?labels=pagewanted&milestone=&state=">Request Page</a>
+ [<a href="{{ base-url }}/other/Propose_New_Page.html" target="_blank" style="font-size: 100%; font-weight: bold;" title="How to Request a New Page">?</a>]
+ </li>
+ <li><a href="{{ site.stage }}/news/Submit_News.md" target="_blank">Submit News</a>
+ [<a href="{{ base-url }}/news/Submit_News.html" target="_blank" style="font-size: 100%; font-weight: bold;" title="How to Submit News">?</a>]
+ </li>
+ <li><a href="{{ base-url }}/other/Contribute.html">More</a></li>
</ul>
</li>
<li>Other
View
8 _includes/other-defs.md
@@ -1,6 +1,6 @@
-[createnewpage]: <CreateNewPage.html> "Create a new Wiki Page"
-[proposenewpage]: <ProposeNewPage.html> "Propose a new Wiki Page"
-[quickstart]: <CreateNewPage.html> "Quick Start on the Community Wiki"
-[quickedit]: <CreateNewPage.html> "Quick Edits to a Page"
+[create_new_page]: <Create_New_Page.html> "Create a new Wiki Page"
+[propose_new_page]: <Propose_New_Page.html> "Propose a new Wiki Page"
+[technology_overview]: <Technology_Overview.html> "Brief Overview of Technology used in the Community Wiki"
+[quick_edit]: <Quick_Edit.html> "Quick Edits to a Page"
[legal]: <Legal.html> "Legal Information"
[contribute]: <Contribute.html> "Contribute to the Community Wiki"
View
4 other/Contribute.md
@@ -25,12 +25,12 @@ The Wiki uses [GitHub Pages](http://help.github.com/pages/); the content itself
branch of the [Community](https://github.com/BlackBerry-Community/Community/tree/master) repo.
We prefer submissions via a GitHub [pull request](http://help.github.com/send-pull-requests/).
-If your change is a simple edit, you should be able to use Inline Editing, see our [QuickStart](QuickStart.html) page.
+If your change is a simple edit, you should be able to use Inline Editing, see [Quick Edit].
### Create New Pages
For substantial changes and for new content, you will need to use Git and GitHub to create and test your contribution;
-see [QuickStart](QuickStart.html) for details.
+see [Technology Overview] for details.
Pages are written using one of these layouts:
* [Basic](example-basic.html)
View
90 other/Create_New_Page.md
@@ -0,0 +1,90 @@
+---
+title: Create a New Page
+
+layout: basic
+---
+{% include other-defs.md %}
+
+This page describes in detail how to create a new page in the wiki;
+for quick changes to an existing page, check [Quick Edit]
+An alternative for some situations is to [Propose a New Page][propose new page].
+
+You may want to check the brief [Technology Overview], or just jump right into the instructions.
+
+### Overview
+
+This Wiki is implemented via [GitHub Pages](http://help.github.com/pages/)
+using [Markdown](http://daringfireball.net/projects/markdown/)
+and [Jekyll](http://github.com/mojombo/jekyll/).
+There are two main repositories: [one](http://github.com/blackberry/Community)
+for the [released Wiki](http://blackberry.github.com/Community)
+and the [other](http://github.com/blackberry-community/Community)
+for the [staged Wiki](http://blackberry-community.github.com/Community).
+
+The steps involved are:
+* Create a _fork_ of the Staging Wiki repository
+* `git clone` from your GitHub fork into a local repos
+* Create the new page in your local repository
+* Test locally
+* `git add` the files
+* `git commit` the changes
+* `git push` the changes to your fork at GitHub
+* Test your changes
+* Send a _pull request_ from your fork to the Staging Wiki
+
+-- IMAGE HERE --
+
+### Once Only
+
+You will need:
+* A GitHub account
+* Git client software installed in your local laptop/desktop
+* Access to GitHub (via ssh or https)
+
+See [Technology Overview] for these.
+
+### Fork the (Right) Repo
+
+
+
+Start by checking if the page you want to propose already exists. Look for the search link in the
+navigation (left-hand side) menu:
+
+<p style="text-align: center; margin:0px"><img src="images/NavigationMenu-Search.png" style="margin:10px;"/></p>
+
+Then follow that link to a Google search page
+that is configured for the Community Page as the "site:" attribute.
+
+<p style="text-align: center; margin:0px"><img src="images/SearchWiki.png" style="margin:10px;"/></p>
+
+### Check if a Request Already Exists
+
+If the page does not exist the next step is to check if somebody has already requested the page.
+Look at the navigation menu, now follow the link labeled: "Propose Page"
+
+<p style="text-align: center; margin:0px"><img src="images/NavigationMenu-NewPage.png" style="margin:10px;"/></p>
+
+This will open a page on the _pagewanted_ Issues on the [Community Repository](https://github.com/blackberry/Community/issues?labels=pagewanted&milestone=&state=):
+
+<p style="text-align: center; margin:0px"><img src="images/CommunityIssues.png" style="margin:10px;"/></p>
+
+### Submit a new Issue
+
+If you don't see what you want there, you can now create a new issue by clicking on the button labeled
+<a href="https://github.com/blackberry/Community/issues/new">New Issue</a>.
+GitHub.com will next ask you to login if you have not done so...
+
+<p style="text-align: center; margin:0px"><img src="images/GitHubLogin.png" style="margin:10px;"/></p>
+
+... and afterwards you can create an issue for your page request using the _pagewanted_ label.
+
+The level of detail will vary depending on the specifics of the pag:
+the snapshow below corresponds to a request to create a new page for Warsaw (<a href="https://github.com/blackberry/Community/issues/69">#69</a>)
+which can be done by just cloning one of the existing pages for other cities.
+
+<p style="text-align: center; margin:0px"><img src="images/WarsawPage.png" style="margin:10px;"/></p>
+
+### Or Create Directly
+
+Finally, do remember that you can also just create a new page by forking the repository and sending a pull request (see
+[details][createnewpage]).
View
2  other/ProposeNewPage.md → other/Propose_New_Page.md
@@ -8,7 +8,7 @@ layout: basic
This page describes in detail how to propose a new page for the Community Wiki,
for situations where [Creating a New Page][createnewpage] is not possible
or practical.
-For quick changes to an existing page, check [QuickEdit].
+For quick changes to an existing page, check [Quick Edit].
### Search for Page
View
2  other/QuickEdit.md → other/Quick_Edit.md
@@ -7,7 +7,7 @@ layout: basic
This page describes how to do quick edit to an existing Wiki Page;
see
-[How to Contribute](Contribute.html) and [QuickStart](QuickStart.html)
+[How to Contribute](Contribute.html) and [Technology Overview]
for more details.
### GitHub, Git and Markdown
View
2  other/QuickStart.md → other/Technology_Overview.md
@@ -1,5 +1,5 @@
---
-title: QuickStart to Git and GitHub
+title: Overview of Technology Used in This Wiki
layout: basic
---

0 comments on commit a65e830

Please sign in to comment.
Something went wrong with that request. Please try again.