Community Documentation

I think we can add the cname to the mkdocs config file too. So it doesn’t change the url.

Really, that would be cool!

Can I get a confirmation please. Did my CNAME finally work.

https://docs.v1engineering.com/ - Does that navigate and work showing that domain name the whole time for you?

Dam, I must have wasted at least half of my day on that and it turns out I just had some crazy persistent browser cache. Note to self always test in a private window.

It’s working for me! It’s a little thing, but it makes it much nicer, imo.

Cool! It was a simple change but the dang browser was not showing it for me. So all that weird stuff I did all day was unnecessary I think.

 

Are you sure? I could have sworn I tried to open it in a private window.

Oh well, it’s working now.

I think my first few tries were right, after that I changed too many things. I did learn a lot though. Tried to be patient and figure it out so hopefully the forum transition is smooth as sandpaper, no worse than that.

Uhhhh, I have not changed anything and it is not working?

What was the second to last thing you did?

These things have to get propogated through the interwebs to the dns servers, right?

I just looked at the setting page and github has populated the custom domains slot but I know I did not do that. Shoot, I have no idea right now is is just circular redirection.

I don’t want to jinx it, but it’s working again.

I have some time today. I’m going to call:

  • Import extruder

We are running out of easy ones…

Exactly the links in a table take forever.

 

I think I have it, it is even simpler that I previously thought, still no idea why it broke the last time though. It could be do to most dns changes having a TTL of 4 hours…

Here is what I did to make the Cname work with MKdocs, Github.io (projects version, not just github.io (projects use gh-pages, github.io uses master branch)), and a Cpanel host.

-Make a file in /docs names exactly “CNAME”. This file will get deployed into the maingh-pages branch. Anywhere else and it will get deleted at deploy, named anything else it will not work.

-Cpanel, simple DNSZones, Cname, add the subdomain (in this case “docs” (docs.v1engineering.com)) as “name”, and as the record add v1engineeringinc.github.io (<username>.github.io).

That is it, no ssl, no creating an actual subdomain, no redirect, just a cname redirect.

 

in case I need to do it again

1 Like

I’m working on the lasers, and I think I’ll have some more time today, so I will also hit milling basics and drag knife. That should close out the tools folder.

You are an animal! Thank you.

I just started using the “Definitions” syntax and it’s pretty nice. Something like this:

[scode]
Difficult Term
: This is what a difficult term is
[/scode]

And I can also use it to sort of add captions.

[scode]
Figure Title
: !figure
[/scode]

Now I’m wondering where I should have used it already…

Can you link one? I am not seeing it.

Basic definition usage: https://docs.v1engineering.com/tools/lasers/#power Things like the Wattage are using that syntax. Here they are in my cheatsheet: https://docs.v1engineering.com/mkdocs_info/#definitions

These images are in a definiton: https://docs.v1engineering.com/tools/milling-basics/#work-offsets .

I thought this was interesting too, putting them in a little note box: https://docs.v1engineering.com/tools/milling-basics/#climb-vs-conventional-milling

Those are from the admonition plugin: https://squidfunk.github.io/mkdocs-material/extensions/admonition/

Maybe I should have just chosen one and stuck with it…

Okay I get it now, I really like that, both ways. Definition is very subtle but clear better than just bold or a different header size, the note box is very bold and creates separation.

We still have not gotten around to coming up with a “style” yet but I am okay with it. I think we will stumble upon a page that looks really good for whatever reason and then making the rest match will be easy(ish). Or someone that knows about this stuff will offer some advice.

And I looooove how you can like to a specific spot on a page. To do that previously for me creating anchors took way more effort.