SienciLabs
commented
3 months ago Wow really speedy!
I did a first and second glance runthrough of it all and so far between your work and some tweaks I made it looks like we might already be close to ready. You did a great job bringing over all the files and text from what I could see. There was some weird legacy "DSLC" stuff that was intermingled with the text but it didn't seem like it was doing much so I got rid of most of it for the sake of readability.
When you go to do more work on your end, make sure you click the little 'refresh' button at the bottom of VS Code next to "Mill-One-Documentation" so that your computer pulls all the new changes I made
Here are some of my notes on things that needed more work that I already took care of:
- Make sure when you're going through the text after copying it over that you use the lint and spell checker to make spelling corrections or amendments to the rules when it makes sense. I already did this for you while going through it myself because I know that right now our dictionary is still in its early stages, so I understand if you don't feel comfortable correcting things, but if you see instances of "Gcode" for example then definitely feel free to correct it since it's still possible that the original docs have outstanding spelling mistakes or poorly used terms. Since I already did this, just something to keep in mind as we do more migration
- I renamed some pictures to be in line with the file naming scheme you chose since there were some areas where they seemed a bit inconsistent
- The folder naming tips I gave you for the pictures I had to apply to the folders you made for the .md files too since I think that would also break the plugin. For the folders with .md files in them, they also need to have an index.md file in them otherwise the folder itself is considered a page that will be published by the plugin. I took care of making all the new index.md pages for that
- For file renaming, I realized there's a nice extension for VS Code called "Batch Rename" that works well for changing many files at once but it takes a bit of getting used to
- All your images had an alt text of "alt text". In the future you'll want to either delete "alt text" so it's left blank, or put in the effort to write an alt text for the picture, though for the time being we probably won't write image alt texts while for now we just focus on migrating over
- All your images also started with "../../_images/" for the image link, I think this should just be "/_images/" without the prior slashes and dots even though I know it's inserting them by default when you copy and paste them over
- On unique pages like the Router Options page, in the future you can look at the text you're copying over in order to make sure you re-create it correctly in markdown. For example the Makita picture has text
<img class="nar alignleft wp-image-633 size-full" src="https://resources.sienci.com/wp-content/uploads/2021/04/Makita-Router.jpg" alt="" width="300" height="300" />so that lets me know that for the markdown I can put{.alignleft .size-full .nar}instead of the typical{.aligncenter .size-medium}
Here are some of my notes so far on what seems like still needs addressing:
- Try to give all Mill One pages a featured image, usually this can just be whatever image that you like the most that's already on the page
Otherwise you did a really great job grabbing and swapping out the images and I'll mostly trust you that the page info is correct until we try importing it over to WordPress
StephenGitHuber
All pages are there, might be some tweaking like the router page pics, youtube links, buttons and captions.