search

opnsense / docs

OPNsense documentation
Other
118 stars 187 forks source link

Links, formatting, and questions in the doc #460

Closed linuxdude21 closed 1 year ago

linuxdude21 commented 1 year ago

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

linuxdude21 commented 1 year ago

I'm sorry, guys. I'm unsure if I'm uploading and creating PR correctly.

AdSchellevis commented 1 year ago

@linuxdude21 are these all modifications? I can squash them into a single commit, as long as the diff is the proposed one

linuxdude21 commented 1 year ago

@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.

AdSchellevis commented 1 year ago

@linuxdude21 ok, I've merged the relevant parts in https://github.com/opnsense/docs/commit/02f7d53076aeec47d7c3b3b0dc7a6343d3c1b8bb 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.

linuxdude21 commented 1 year ago

@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.

linuxdude21 commented 1 year ago

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.
https://github.com/linuxdude21/docs/commits/master/source/manual/install.rst

AdSchellevis commented 1 year ago

@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.

linuxdude21 commented 1 year ago

@AdSchellevis Just to confirm should I delete my https://github.com/linuxdude21/docs fork? and re-fork?

AdSchellevis commented 1 year ago

@linuxdude21 that's probably the easiest option indeed