New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Wiki page link for every in-app screen #208
Comments
Agreed. How about stridercd.com/docs? We could have that auto-generate from a repo. Perhaps use sphinx or something similar? We can provide hosting of docker images or whatever to do this. I found github pages not all that reliable so probably better to self-host. However I'd caution we should be careful not to bite off more than we can chew for the 1.4 release. Let's not couple a slick website directly to the software version. We should quietly get the code out there, make sure it's stable, develop a solid list of plugins, work on docs. When we are ready for the attention, we can have a more "marketing"-focused release (perhaps under the moniker Strider 2). |
I'm in favor of docs.stridercd.com forwarding to stridercd.github.io - it'd Happy to spearhead this... Peter Braden On 15 October 2013 07:56, niallo notifications@github.com wrote:
|
On the other hand, github pages kinda suck as they are in a separate branch thus they can get out of date pretty easily. Perhaps we do just build them from whatever is in the docs folder - the public strider instance can rebuild on every commit. |
Bootstrap uses gh_pages, docker uses sphinx. |
for a lot of front-end devs, markdown is more accessible, but the On 10/15/13, Peter Braden notifications@github.com wrote:
|
I agree - markdown is preferable |
Any thoughts on this? I'd love to start working on docs. I've used Sphinx before but I don't care much about the specifics of the tool. |
I'd vote for github pages + markdown. We can look at bootstrap's docs as a On Tue, Oct 22, 2013 at 2:59 PM, niallo notifications@github.com wrote:
|
let's just start writing docs in markdown in the repo - we can always work on nicer layout later, but the content is the priority |
sounds good On 10/22/13, Peter Braden notifications@github.com wrote:
|
I was looking for a CD tool and strider comes out as one of the top candidates. I like the architecture, and there seems to be a fair amount of active development... but all documentation seems to be aimed at strider developers, not actual strider users? The "book" starts out well but just has a few pages. In particular, what are the configuration defaults? I've created an admin user, typed "npm start" ... now what? where is my dashboard? How do I create a project? Is strider just a captive project for docker (and/or etc?) If not, I must admit I'm puzzled. Why have you spent so much effort (and seem to still be putting effort into) creating strider but almost none telling anyone how to use it? |
Great questions. My answer/excuse is that I'm a terrible marketer and the To me it feels like Strider is a Dev (or Ops, or devops) tool and so This is how it went for me, yes the docs suck, but having become an
|
Almost forgot: Strider has great Docker support because it has a well
|
"Captive project" -- just that when googling around for info, I found more info on strider in docker than on strider per se. I don't know who you or the core strider or docker devs are but one hypothesis was that this was a public repo "thrown over the wall" and that is why you didn't bother to document the system as such but still found the time in your busy lives to write & maintain lots of code. ... anyway: as I said I was drawn to the architecture -- I can imagine that flying at cruising altitude is quite nice. But takeoff is still pretty bumpy! I've been building a project w/ manual tests, but am now about to deploy it. In preparation to shifting from building to maintaining, I wanted a nice, simple, modular continuous development system written in either node (best) or python (2nd best), which I could later add tasks (such as deployment) to simply but now could get up and running fast. You and buildbot came to the top of the list. I'll fiddle with it for the rest of the day... but if it takes me more than a day to get running I'll go on to buildbot. [right now I found the dashboard, but cant seem to create a git project pointed at my gitosis repo... hmm... where is the project data stored -- in mongo? so why is it asking me about a cache between runs...?] |
So, um.. prompt for surgical additions: :) On projects/manual add tab, could you give an example of what valid entries look like?
|
Ok ... so a look at the html code reveals that not only does the URL require one slash but the slash must be in between two words. (regex pattern |
Ok ... first test working :) SO -- PLEASE -- if you could spend 15 min documenting projects/manual add I'm sure you will get a lot more people coming in the door.
|
Suggestion on breaking down doc into pieces: |
@shaunc Thanks for the suggestions!
|
Ooh that's a really good idea! Thanks |
Totally agree the docs need work. I got drawn to Strider for its simplicity to get going, but there were still a lot of little questions and I think that especially if you are coming more from the dev side than the ops side, you need more guidance to get started with a self hosted CD system. Great suggestions from @shaunc |
Great suggestions for sure. I definitely agree that docs are Strider's biggest weakness. I can take responsibility for that since I didn't personally write good documentation when I started the project. I did begin the Strider book, however the reality is I didn't have time to finish that on my own. Writing an entire book is a huge commitment. However perhaps if we can just get the ball rolling, then people in the community can feel empowered to participate and the effort will snowball. I like the Wiki approach for that reason. Having a mapping from screen to wiki page is a great idea. |
I think 1.4 will in many ways be our debut, and we need killer documentation and a website that really makes it clear how awesome strider is.
Examples of awesome documentation:
Currently strider-cd.github.io reroutes to stridercd.com, which does not correspond to a gh-pages anything. Could we get docs.stridercd.com which does map to the gh-pages? Or maybe just remove the redirect so strider-cd.github.io does the normal thing?
The text was updated successfully, but these errors were encountered: