Restructuring wiki before update PDF instructions

Have a suggestion for the website or forum? Post it here.
WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Restructuring wiki before update PDF instructions

Post by WillAdams » Mon May 13, 2013 1:49 pm

Thought this merited its own topic.

I think there are some final things which need to be done first:

- I'm not wild about the bifurcation of having Assembly Step 16 being nothing but a pair of links, and then a valid assembly instruction page being hidden away under ``Using Your Machine'' as ``Run Your First Job'' --- will probably move Run Your First Job and Run Your Second Job into the Assembly Steps as 16 and 17 (I guess we'll have to set redirects from those pages to those Step #s).

- the basic 2D and 3D workflow pages are too good / valuable to hide away --- I think they should be reworked and moved into ``Using Your Machine'' (see my post on naming convention for my thoughts on that)

- this would leave us one step short, so I'm open to suggestions (my inclination would be to get away from numbering the underlying page names for the steps --- handle the numbering via re-directs), but that creates other issues I'm not willing to deal w/ --- most expedient would be to just move current 19 to 18, but I'm thinking I'd rather have a calibration page --- how does everyone feel about a compleat set of instructions for:

1 - drawing up a machinist's diamond-circle-square test
2 - created CAM files for it
3 - running said files
4 - measuring them to determine the machine's squareness, accuracy and spindle run-out

(or am I missing the purpose of that shape?)

William
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

bobt
Posts: 132
Joined: Tue Apr 17, 2012 7:08 pm

Re: Restructuring wiki before update PDF instructions

Post by bobt » Mon May 13, 2013 5:50 pm

William - yes to what you said. But also include the .nc file that was generated because what we want the user to initially do is to validate the machine. Then they should go thru the process of generating the code and matching it against the provided .nc file so that they have a comfort factor in what they did.

Bob Teeter
"What Box???" ShapeOko #397

WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Re: Restructuring wiki before update PDF instructions

Post by WillAdams » Tue May 14, 2013 2:42 pm

Got logged out and lost the text.

Short version: Working on this, changed the font, used a nice version of the open hardware logo --- we need to re-create the shapeoko logo.

Preview version of the cover attached:
Shapeoko_Build_Instructions_Cover_v1j-page001.png
Shapeoko_Build_Instructions_Cover_v1j-page001.png (285.3 KiB) Viewed 1921 times
Any constructive criticism or suggestions?
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

cvoinescu
Posts: 4442
Joined: Thu Jul 19, 2012 6:50 pm
Location: Camberley, UK
Contact:

Re: Restructuring wiki before update PDF instructions

Post by cvoinescu » Tue May 14, 2013 2:49 pm

Where are the belt anchors on the X axis???!!!!?!!!11eleven1!

Seriously now, it's great. :)
Proud owner of ShapeOko #709, eShapeOko #0, and of store.amberspyglass.co.uk

WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Re: Restructuring wiki before update PDF instructions

Post by WillAdams » Tue May 14, 2013 3:24 pm

Good catch.

Drew them back in by hand. How's this?
Shapeoko_Build_Instructions_Cover_v1j-page001.png
Shapeoko_Build_Instructions_Cover_v1j-page001.png (287.99 KiB) Viewed 1916 times
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Re: Restructuring wiki before update PDF instructions

Post by WillAdams » Tue May 14, 2013 4:25 pm

Okay, I'm mystified as to how one uploads new files into github.

Anyone have a clue?

William
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

edwardrford
Posts: 1250
Joined: Mon Apr 09, 2012 5:40 pm
Location: Dixon, IL
Contact:

Re: Restructuring wiki before update PDF instructions

Post by edwardrford » Tue May 14, 2013 6:16 pm

You need to install the GitHub software, then clone the Shapeoko repository into your local machine. Then you can edit that local repository and do a pull request. The repo admin (me at this point in time) will then grant the pull and your files will be in the current repo.

Edward
Shapeoko 1 #0 - a couple of upgrades.
Shapeoko 2 #0 - a couple of upgrades.
Shapeoko 3 #2 - Stock

WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Re: Restructuring wiki before update PDF instructions

Post by WillAdams » Tue May 14, 2013 6:44 pm

Okay. I'll see what I can manage w/ that.

In the meanwhile, what are the thoughts on the revised Step 1:
Shapeoko_Build_Instructions_v1j-page001.png
Shapeoko_Build_Instructions_v1j-page001.png (158.41 KiB) Viewed 1897 times
Changes are pretty minor:

- new font
- re-set the styles
- shifted text boxes around a bit
- smaller open hardware logo

I'm not wild about the placement of the URL --- thoughts on where else it could go?

This does raise the matter of the unified Item #s --- should I edit the underyling .pdf so that it uses the same item #s as the B.O.M. in the wiki?
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

edwardrford
Posts: 1250
Joined: Mon Apr 09, 2012 5:40 pm
Location: Dixon, IL
Contact:

Re: Restructuring wiki before update PDF instructions

Post by edwardrford » Wed May 15, 2013 9:04 am

Couple things:

1.) this will get you started on GitHub: http://try.github.io/levels/1/challenges/1

2.) I like the changes , good choice on font, an the layout looks a little cleaner.

3.) URL: what if we only showed the end of the URL? or if We switched them to a mnml style like bit.ly or something similar?

4.) item numbers: not sure about that one. Ill have to give it some thought.

-Edward
Shapeoko 1 #0 - a couple of upgrades.
Shapeoko 2 #0 - a couple of upgrades.
Shapeoko 3 #2 - Stock

WillAdams
Posts: 8542
Joined: Mon Apr 09, 2012 6:11 pm
Location: Pennsylvania --- south of the Turnpike, East of US-15
Contact:

Re: Restructuring wiki before update PDF instructions

Post by WillAdams » Wed May 15, 2013 12:08 pm

Okay, here's a slight tweaking:

- moved the URL up under the STEP # text --- simplifies the page and makes it into a decorative element underlining that.
- reduced the H3 text from Bold to Medium --- reduces the clotted appearance of the heaver text
- tweaked some of the text (mental note, go do that to the matching text in the wiki --- I can't believe that there isn't an option for opening a wiki page in Scribus and parsing mediawiki markup) --- there are times I really miss NaviPress)

I guess we need a comprehensive decision on the Item #s --- should I set the ones on the wiki back to numbering per step, or include a parenthetical # for the .pdf?
Shapeoko_Build_Instructions_v1j-page001.png
Shapeoko_Build_Instructions_v1j-page001.png (155.99 KiB) Viewed 1891 times
And going through the pages, I found that I needed to remove the text ``wiki link: '' and slightly reduce the text size above and below the grey Step #.

I've also found myself slightly re-structuring the wiki and adding some additional text to explicate each assembly.
Shapeoko 3XL #0006 w/ Carbide Compact Router w/0.125″ and ¼″ Carbide 3D precision collets
Nomad 883 Pro #596 (bamboo)

Post Reply