Add your project to developer.parallax.com!
Brett Weir
Posts: 288
Hi there,
I've been working on a new area of the Parallax website that I'd like to share with you all.
Introducing developer.parallax.com.
This site is going to be the new home page for Parallax open-source development efforts. It's is automatically generated from the projects in the Parallax GitHub, so you can prettify your project with only a few simple changes.
How can I participate?
Tricking out your project is as easy as three steps.
Step 1: Add a README
Make a nice, preferably markdown-formatted README for your project. This will be rendered into the source html for the page.
Step 2: Add a site.yml config file to your project root
Add a YAML-formatted file where you can include some custom options for your project. Supported so far:
Add a nice cover photo on the main page.
Categorize your application (current options are tools|compilers|libraries|hardware|other, but do suggest more!):
Add custom links at the top:
Put it all together for your complete site.yml configuration:
Step 3: Wait
The site will be updated to reflect your changes in a day or so, or submit an issue requesting a rebuild for faster turnaround.
Going further
Documentation
I have a template I've been developing for hosting Doxygen documentation in GitHub. You can see an example here:
http://developer.parallax.com/docs/propellermanager/html/
The deployment process is still fairly experimental but I'm looking for people who are interested to try it out. Contact me for more information.
Releases
If your project uses Github Releases to publish release artifacts, this site will automatically publish the latest release that is not marked as draft or prerelease. You can see an example here:
http://developer.parallax.com/propelleride/
It attempts to guess the target based on file extension, so let me know if you need an extension that hasn't been included.
In closing
With these minor tweaks, you can turn your existing project into a beautiful website that will get your project noticed.
If you're still not using the Parallax GitHub, there's never been a better reason to start. Submit an issue to the project https://github.com/parallaxinc/parallaxinc.github.io with the title "Add PROJECTNAME to parallaxinc", where PROJECTNAME is your project's full name (e.g. parallaxinc/PropellerIDE), and we can start the conversation.
Join today and become a part of Parallax open source!
I've been working on a new area of the Parallax website that I'd like to share with you all.
Introducing developer.parallax.com.
This site is going to be the new home page for Parallax open-source development efforts. It's is automatically generated from the projects in the Parallax GitHub, so you can prettify your project with only a few simple changes.
How can I participate?
Tricking out your project is as easy as three steps.
Step 1: Add a README
Make a nice, preferably markdown-formatted README for your project. This will be rendered into the source html for the page.
Step 2: Add a site.yml config file to your project root
Add a YAML-formatted file where you can include some custom options for your project. Supported so far:
Add a nice cover photo on the main page.
image: icons/logo.png
Categorize your application (current options are tools|compilers|libraries|hardware|other, but do suggest more!):
type: tools
Add custom links at the top:
links:
Source Code: https://github.com/parallaxinc/PropellerIDE
Docs: /docs/propellermanager/html
Some Other Thing: www.google.com
Put it all together for your complete site.yml configuration:
image: icons/logo.png
type: tools
links:
Source Code: https://github.com/parallaxinc/PropellerIDE
Docs: /docs/propellermanager/html
Some Other Thing: www.google.com
Step 3: Wait
The site will be updated to reflect your changes in a day or so, or submit an issue requesting a rebuild for faster turnaround.
Going further
Documentation
I have a template I've been developing for hosting Doxygen documentation in GitHub. You can see an example here:
http://developer.parallax.com/docs/propellermanager/html/
The deployment process is still fairly experimental but I'm looking for people who are interested to try it out. Contact me for more information.
Releases
If your project uses Github Releases to publish release artifacts, this site will automatically publish the latest release that is not marked as draft or prerelease. You can see an example here:
http://developer.parallax.com/propelleride/
It attempts to guess the target based on file extension, so let me know if you need an extension that hasn't been included.
In closing
With these minor tweaks, you can turn your existing project into a beautiful website that will get your project noticed.
If you're still not using the Parallax GitHub, there's never been a better reason to start. Submit an issue to the project https://github.com/parallaxinc/parallaxinc.github.io with the title "Add PROJECTNAME to parallaxinc", where PROJECTNAME is your project's full name (e.g. parallaxinc/PropellerIDE), and we can start the conversation.
Join today and become a part of Parallax open source!
Comments
Looking good!
Perhaps I should put my P8XBlade2 here ???
Cluso, is the project you're looking to add already on GitHub? If so, post a link to it so I can check it out. Then send me an email at contact@lamestation.com so we can talk.
No. I don't know GitHub.
The hardware is here...
http://forums.parallax.com/discussion/163052/cluso-s-p8xblade2-tiny-p8x32a-propeller-development-board-released/p1
http://www.clusos.com/p8xblade2/home/p8xblade2-2/
And the software (PropOS) is here...
http://forums.parallax.com/discussion/138251/a-propeller-os-that-can-run-on-multiple-hardware/p1
-Phil
A version control system is a wonderful thing. Problem is all such systems have been harder to use that they are worth for small projects and lone developers. And usually slow. As such they did not get used except by force when working in teams on large projects.
Git though is simple and fast.
But we are talking opensource projects here. So you publish the code. People try it out. They report bugs and perhaps provide patches and new features. Then git helps that collaboration.
Let's take a recent example from the forum. The Taz compiler. It was posted here as a zip. Then quickly came a revision in another zip. Then came a patch file. This is a lot of faffing around for those who want to try it out. And prone to error and confusion. Whereas a simple:
$ git clone https://github/user/Taz
(What ever the URL may be) would be so much easier.
When revisions come it's just:
$ git pull
Github is the icing on the cake because you don't need to be maintaining your own git server. You can quickly fetch your own code to any machine you happen to find yourself in front of.
Then, github provides a useful API to it's service. developer.parallax.com is an example of the use that can be but to.
Many things about the internet are frightening. But I can't for the life of me imagine why anyone would be fearful of using github for their open source software.Or even private commercial code for that matter.
Using git to help manage development of your project is a great way to help yourself. Pushing changes to a git repo is dead easy. Having that repo accessible to everyone else in the world makes life easy for them too. Then even the smallest projects can attract collaborators. My FFT and Z80 emulator projects contain code and patches from a number of people. I wish I'd used git for the latter especially as now I have a bunch of versions with different capabilities in different directories and zip files and after all this time I'm not sure what is what anymore!
It makes a lot of sense for Parallax to use Github rather than maintain OBEX.
If you don't like Github there is always BitBucket and others. Or run your own git server.
I'd also like PropWare listed as both a library and a tool - is that supported? I took a guess and did space-separated categories, but let me know if I should switch to comma separated.
Here's my site.yaml file:
It sounds like the projects have to be transfered to live under the "parallaxinc" GitHub organization. Is this correct?
It should be noted that the Parallax github and OBEX accomplish very different, complementary goals.
With OBEX, anyone can put up anything, so it's a great way to draw a large net and collect many different one-time contributions.
Some projects start to build momentum and become established in the community. These kinds of projects:
Some examples off the top of my head:
These are the kinds of things that should be found on the Parallax GitHub.
Hi David! I'm happy to hear PropWare is coming on board.
I'll add the "readme" key for that purpose, so add this to your site.yml.
I haven't added support for multiple categories yet, but the syntax will use the bar character ( "|" ).
Oh, also, a "Code" link is added automatically, and if you're using GitHub issues, that will be added automatically too. I'll update the README on the developer site to reflect all of these.
Yes, that's correct, and a group will be created so that you can manage it from there.
I've also updated the yaml config file to use the pipe for the categories, thanks
Now it's just a waiting game with Parallax. And this is the perfect timing too - I'm almost ready with a final 2.0 release!