Oops, width looks better. 400 seems good. Ending each looks pretty good with a horizontal line, ___, gives it a little differentiation or something.
I went through the v1engineering docs and made a first pass at a tree of what is there. I put a dummy file in for each one and I put them all in a PR:
Next is, we need to convert the pages from v1 to github. There’s a lot of content there and it will take a while to move it all, so it would be great if some of the community would volunteer to do some pages. Here’s how I think we can do it to avoid trouble:
-
In this forum post, point out which page you’re going to edit. The first person to post about it will edit it.
-
Click on the pencil in the top right of a page. The first link on the page should be to the v1engineering site where the content is coming from. Copy text, Make similar headings, and put the same images back in. A couple tips:
-
It will be really tempting to “edit” and “author” new stuff right away. For the sake of git and a reduction in chaos, it will be a lot cleaner if you just copy it as-is first. If you see a misspelled word, go ahead and fix it, but don’t rewrite sentences completely (yet).
-
You can right-click on an image at v1engineering.com and select “copy image location”. That is the address of the image you can put into markdown.
-
If you are having trouble making links or linking images, just point it out to us, and we’ll fix it before merging it in.
-
Edit the about.md page and add yourself as a contributor.
-
Make a Pull Request, which I think git will help you with when you click on the pencil in the top right of a page. Ryan and/or I will check it out, maybe do one or two items of polish to make sure all the links are right, merge it, and then deploy it to the website.
After we’ve got the pages up, we can start looking hard at editing or reorganizing things. Having the info in markdown format makes it much easier to move around or change. Just making this documentation at least as useful as the original is a huge step forward, and we need to get there soon, or Ryan will go nuts trying to change two pages while there are still two copies.
[scode]
├── electronics
│ ├── dual-endstops.md
│ ├── index.md
│ ├── marlin-firmware.md
│ ├── ramps.md
│ ├── steppers.md
│ ├── ultimachine.md
│ └── v1pi.md
├── lowrider
│ └── index.md
├── mp3dp
│ └── index.md
├── mpcnc
│ ├── base.md - Jamie/vector76
│ ├── belts.md
│ ├── conduit.md
│ ├── final.md
│ ├── gantry.md
│ ├── index.md
│ ├── middle-assm.md
│ ├── table.md
│ └── z-axis.md
├── software
│ ├── estlcam-2p5d.md
│ ├── estlcam-basics.md
│ ├── index.md
│ ├── repetier-host.md
│ └── reverse-motor.md
├── tools
│ ├── drag-knife.md
│ ├── import-extruder.md
│ ├── laser-engraving-mirrors.md
│ ├── lasers.md
│ └── milling-basics.md
└── zenxy
└── index.md - Ryan/vicious1
[/scode]
I count 26 pages left. Not too bad, since we don’t have to type them all out.
Are you missing the MP3DP there, or is it already done?
It is missing. I made a note of it, but I’m waiting for Ryan to fix it.
I went ahead and added it. It’s currently only one (very long) page.
Beast mode Heffe! Rough couple of weeks for me but I hope things are getting back to normal, Inventory is shipping and inbound, house is no longer flooded, water is not leaking out of my main waterline, sewer is fixed, firmware is up to date (relatively), github docs work, hate mail is slowing considerably.
I am beat for the day but I am eager to get at it early tomorrow.
In the evening tomorroe, I hope to put some time into a few pages myself. I appreciate the help all of you have given thus far. I figure if we get a few more pages done maybe I can put a front page post up to get things kick started.
I merged and deployed that PR. Ready for edits.
1 Like
I’m working on converting:
software/estlcam-2p5d.md
software/estlcam-basics.md
software/index.md
1 Like
Do you all have this set up to auto deploy on merges back into master? It’d be easy enough to have https://travis-ci.org/ build and deploy docs out to where ever. If you’re going the GitHub route I’d recommend going ahead and setting up a GitHub Organization. As far as gating what goes back into master you can set up GitHub CodeOwners to require that certain individuals/teams review pull requests. You can even assign code owners to specific directories/files so that no one person has to be an expert on everything. I will say that all of this is a bit more developer-centric that some users may like but it doesn’t bother me 
Happy to give a hand setting up TravisCI to auto build/deploy if you all would like.
Edit: Set up GitHub branch protection on master to prevent @jeffeb3 from force pushing. 
2 Likes
I’ll take assembly/middle for the MPCNC
2 Likes
It’s not. Travis seems easy enough to set up, but the commercial version is too expensive ($63/month, IIRC). I was thinking there must be something we could do on a pi to do the same thing. But it literally takes 30 seconds to do it if I’m not already at my computer. If I am already at my computer merging changes, then it’s basically free. Travis has the advantage of not fat fingering a deploy and always deploying the right commit though.
I definitely would do this if it were my repo. Ryan has given me some permissions, but I can’t tweak branch permissions. I would also only allow merge commits from PRs, but I given the audience, I don’t want to make it too hard. The easiest time to sell permissions like that is right after a problem :).
Now that things are basically started, I’m assuming it’s Ryan’s responsibility to at least approve PRs. I’ll do what I can to review them and do minor tests. When we get more contributions, I assume some other permissioned volunteers will become obvious. If I notice gh pages is out of date, I might use my powers to deploy, but otherwise not.
FWIW, these pages took about 20 minutes each. The hardest part was copying the links and images. I was trying hard not to type anything, just copy paste. But my mousing is slow.
Ugh. Python and I do not get along at all…
I cloned the repo, and have done the following trying to get mkdocs to work:
385 pip install mkdocs 386 sudo pip install mkdocs 387 cd V1EngineeringInc-Docs/ ... 393 mkdocs serve 394 sudo pip install pymdown-extensions 395 mkdocs serve 396 sudo pip install pyembed-markdown 397 mkdocs serve ...413 git clone GitHub - g-provost/lightgallery-markdown: Markdown extension to wrap images in a lightbox.
414 cd lightgallery-markdown/
415 python setup.py install
416 sudo python setup.py install
417 cd …
418 mkdocs serve
And here’s where I am now:
INFO - Building documentation... ERROR - Config value: 'theme'. Error: Unrecognised theme name: 'material'. The available installed themes are: readthedocs, mkdocsI'm at the point where I think python is some elaborate decade-long practical joke on me. Literally every time I've tried to use it for anything I would follow the instructions and it would end up in this unresolved dependency quagmire...
ETA: sudo pip install mkdocs-material was the missing link. Got it going now.
Is there a better way to do that? If so, please tell me and put it in the ‘getting started’ section of the repo…
1 Like
Oh shoot. I should make that easier to find. I don’t know what system you’re on, and I only know Linux :).
You’re real close. Assuming pip permissions are ok, you just need to install mkdocs-material.
https://v1engineeringinc.github.io/V1EngineeringInc-Docs/mkdocs_info/#installing-dependencies
What I do is:
- Clone the repo and cd into it.
- virtualenv -p python3 venv #this may nit be exactly the syntax.
- source ./venv/bin/activate
- pip install -r requirements.txt
- mkdocs serve
Pip can install a ton of things pretty darn quickly, so if I use it outside of a virtualenv, I do pip install --user <package>. That can still be pretty dangerous in general though.
This is just if you want to run mkdocs. You can also edit in github if you feel like it.
Thanks for pushing through.
1 Like
@jeffeb3 I’m just pulling your leg about force pushing to master! Definitely appreciate the desire to make docs more accessible / crowd sourced.
TravisCI is free for open source repositories. Not sure if licenses and such make that an issue for this use case.
Added benefit of TravisCI is that Ryan wouldn’t have to distribute deploy keys to anyone. PRs drive documentation changes and people are completely taken out of the loop to see changes deployed.
Happy to lend a hand if you’d like.
[attachment file=117344]
No worries. I knew it was a joke.
I really don’t know. The documentation and the machine have an NC license right now. Not sure where the rules are.
The deploy is just pushing to the gh-pages, so the permissions are currently managed by github. There aren’t any branch permissions, but Ryan could make the same permissions on gh-pages as master.
Circle CI is free for a basic ?build? is it the same thing? Most of the things you are talking about is above my pay grade but know I am furiously googling to try and understand…
Looks like a friendly service. I can check it out after the kiddos go to bed.
They’re competitors and more or less the same thing, yeah. I don’t think the licensing is going to be a big issue either way so pick whatever is easier to set up. I only mentioned it because it was brought up earlier in the thread.
mkdocs itself uses travis, fwiw: https://github.com/mkdocs/mkdocs/blob/master/.travis.yml