Updates for ease of newcomers #13
Conversation
Putting this here as a start to drafting up possible changes to this to make it easier for newcomers to jump in with helping with the site. This is to stay a draft until such a time we're satisfied with it. Plus this opened a issue we'll need to look at org wide for other operating systems. Toolbox is linux only as far as I can tell and I don't see any reasoning to change off that recommendation for linux, HOWEVER we will need alternatives that make it easier to follow our workflows and generate custom images imo.
Typos fix, thanks @softcode589 Co-authored-by: softcode <108250871+softcode589@users.noreply.github.com>
|
Yeah, that was a mistake on my part. Not sure what happened, and it was a quick and dirty rough draft since it's obviously going to need massive updates to accommodate for other operating systems. Plus for some reason my language tool extension thing doesn't work in the markdown editor. Went ahead and added those changes, while I await the opinions of others as well to make sure we're not excluding those other OS's that I have no way to test for at the moment. |
README.md
Outdated
|
|
||
| ### Tools Needed: | ||
| - Toolbox: We recommend using this as a development tool. It helps with containerization of development. | ||
| - This can be setup in most distributions of linux using your package manager or with brew. Brew can also be used on Mac but if that's not ideal we recommend getting directly from the [official website](https://containertoolbx.org/). |
There was a problem hiding this comment.
Maybe once we have more details we could go ahead and make each OS it's own bullet point, like so:
- Toolbox: We recommend using this as a development tool. It helps with containerization of the development process.
- Linux: ...
- Mac: ...
- Windows: ...There was a problem hiding this comment.
I mean, there's also Vagrant like @autumnblazey mentioned in discord. I've just no clue in writing images to make sure our dev environments are synced up. It's why I went the route of toolbox, since it makes it simple without me having to touch things with writing an image. Totally open to changing that, and would end up with Toolbox under Linux as an option or having Vagrant with some pre-made images based on the person's OS/packaging flavor IMO.
There was a problem hiding this comment.
I was more meaning this as then to detail instructions of the tool for the different OS's like so. For example:
- Toolbox: ...
- Linux: Can be set up in most distributions using your package manager or with brew.
- Mac: Can be setup with Brew, or otherwise setup using the [Official Website]()
- Windows: ... idk Get rekt or somethingThere was a problem hiding this comment.
Yea just gonna close this conversation. This is something we need to discuss and change to other tooling so that people's stuff doesn't break when helping us. Preferably vagrant or something like that (if we can find a universal gui for setting this up…).
Co-authored-by: confused_techie <dev@lhbasics.com>
Change from absolute language to recommended. Co-authored-by: confused_techie <dev@lhbasics.com>
Adding these suggestions to the file. Will still have to edit out the parts where I suggested toolbox for other platforms. Co-authored-by: Spiker985 <7829451+Spiker985@users.noreply.github.com>
kaosine
added
enhancement
Putting this here as a start to drafting up possible changes to this to make it easier for newcomers to jump in with helping with the site. This is to stay a draft until such a time we're satisfied with it.
Plus this opened a issue we'll need to look at org wide for other operating systems. Toolbox is linux only as far as I can tell and I don't see any reasoning to change off that recommendation for linux, HOWEVER we will need alternatives that make it easier to follow our workflows and generate custom images imo.