Links, formatting, and questions in the doc #460
Conversation
First-half installation page change. I wanted to know what you all think before continuing to update the 2nd half of the installation guide. The biggest changes are the order (flow) of the install guide and OPNsense Importer. Order: The page first talks about Image types then jumps to Download & verification (should be closer to the installation section), and then back to installation Media, naming, etc. The flow in this change is installation images/media, downloading, verifying, and installing. OPNsense Importer: Complete rewrite to give direction on how to use it. Removals: LibreSSL vs OpenSSL Cut back on the directions for downloading image files, as the previous directions failed after step 2. Most browsers today download even if you right-click and open in a new tab. (lands signed and verified in the GUI of the running software) Updates: Installation Media adding Image Type column add openssl checksum step
Rewrote Embedded vs Full section using the suggestions PR #456 . Corrected /var/log for re-writes Added more to OPNsense Importer breaking the directions in two: existing installations vs New
Re-ordered Boot Preparation under Installation Method. Changed the Section names around. Some other mirror text exits. Please tell me if I'm going in an unwanted direction?
ReST edits. Still learning
Changed Boot Preparation > System Boot Preparation, and updated the section. Lite touches to Importer section. Creating flow between Importer and Live environment. Rewrite Live Environment section. Thoughts?
Moved the nano Image section. Re-write of the nano section. Made some modifications to Live Environment section Re-write of install to target system to OPNsense Installer
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Co-authored-by: Franco Fichtner <franco@lastsummer.de>
Fixing broken links updating and improving formatting Need someone to review the internal comments? If there is a better way of asking these question please let me know.
|
I'm sorry, guys. I'm unsure if I'm uploading and creating PR correctly. |
|
@linuxdude21 are these all modifications? I can squash them into a single commit, as long as the diff is the proposed one |
|
@AdSchellevis Sorry I believe the answer is yes. These are mostly the corrections to fix the minor errors with the first merge. I'm still planning on updating the last section in the doc. But I need some questions answered that are in the comments in the doc. |
|
@linuxdude21 ok, I've merged the relevant parts in 02f7d53 and fixed some styling issues. I don't mind if you do want to extend some more, but let's try to focus on the sections that need work and keep fixes small so their easy to review and pull in. |
|
@AdSchellevis Thank you for supporting me on this. I believe I'm doing something wrong, but I don't know what that is. Honestly, I'm not trying to be sensitive here. I honestly want to take your guy's lead here as I update this guide. Too many PRs? or commits? :) I'm using Github desktop and vscode now. I'm doing something wrong with those tools. I am a complete noob to both of them and reST. |
|
Sorry I did not mean to add this commit. I'm completely f'ed on git right now. Trying to get my local repo to the same as: 02f7d53 This is what I ended up doing. I'm completely lost. |
|
@linuxdude21 no problem, easiest option when you're lost with your branch is to drop your local one and fork again. The start is always challenging with new things, GitHub does offer quite some documentation about how to propose changes (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) maybe that helps. |
|
@AdSchellevis Just to confirm should I delete my https://github.com/linuxdude21/docs fork? and re-fork? |
|
@linuxdude21 that's probably the easiest option indeed |
Fixing broken links
updating and improving formatting
Need someone to review the internal comments? If there is a better way of asking these questions please let me know.
Thanks