deconst / deconst-docs

Documentation for the Deconst project itself.
https://deconst.horse/
6 stars 12 forks source link

Document pull request builds. #230

Closed smashwilson closed 8 years ago

smashwilson commented 8 years ago

Fixes #223.

smashwilson commented 8 years ago

If you want to double-check your formatting, check the preview.

smashwilson commented 8 years ago

Note to future self: the GitHub status plugin doesn't seem to be firing. I'll need to investigate on Monday.

smashwilson commented 8 years ago

The organization of the "Authoring Content" section is not great right now. We have:

I'd like to break it up and shuffle things around a little to be more useful. Here's what I'm thinking now:

@meker12: does this sound a bit more useful? Is there anything else that I should try to add here?

meker12 commented 8 years ago

@smashwilson I like your proposed restructuring. It's useful to have the more detailed, technical stuff for people who want to have a deeper understanding of the system for troubleshooting and such. So, I wouldn't get rid of the existing content. I see the content you propose as the layer on top that's more functional for people who are using deconst for authoring, build, and deploy.

smashwilson commented 8 years ago

:mag_right: Preview

smashwilson commented 8 years ago

@smashwilson I like your proposed restructuring.

:+1: Cool, I'll move ahead with it as part of this PR. (This is also useful for me to identify and chase down any issues with the Strider PR builds.)

It's useful to have the more detailed, technical stuff for people who want to have a deeper understanding of the system for troubleshooting and such. So, I wouldn't get rid of the existing content. I see the content you propose as the layer on top that's more functional for people who are using deconst for authoring, build, and deploy.

Yeah, I don't think I'm deleting anything, just shuffling it around and adding a section or two. The sections about custom builds and special cases is especially important for anyone adding content that doesn't fit our "easy path" criteria, for example. I was just re-skimming it with a critical eye and realizing that it was much too front-and-center for the most common reader right now, who does meet those criteria.

smashwilson commented 8 years ago

Your content preview is now ready. :bow:

smashwilson commented 8 years ago

To elaborate, you can see the log for the latest Strider pull request build after clicking "Show all checks":

screen shot 2016-03-14 at 10 20 34 am

Or by clicking on the green check or red X on any specific commit:

screen shot 2016-03-14 at 10 20 54 am

smashwilson commented 8 years ago

I'm going to split the general restructuring out into its own issue, then merge this as-is so we have something in the short term, especially now that pull request builds are live.