Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates for ease of newcomers #13

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Updates for ease of newcomers #13

wants to merge 7 commits into from

Conversation

kaosine
Copy link
Member

@kaosine kaosine commented Sep 15, 2022

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.

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.
@kaosine kaosine requested a review from a team September 15, 2022 21:45
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some English rules and unknown double-spacing.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Typos fix, thanks @softcode589

Co-authored-by: softcode <[email protected]>
@kaosine
Copy link
Member Author

kaosine commented Sep 15, 2022

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.

Copy link
Member

@confused-Techie confused-Techie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This mostly looks like a good start, added some ideas, or fixes, and one that isn't for this specific PR, but is getting caught here at least.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 something

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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…).

@kaosine kaosine added the help wanted Extra attention is needed label Sep 16, 2022
Spiker985 and others added 2 commits September 16, 2022 19:40
Co-authored-by: confused_techie <[email protected]>
Change from absolute language to recommended.

Co-authored-by: confused_techie <[email protected]>
Copy link
Member

@Spiker985 Spiker985 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured I'd add some suggestions as well.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
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 <[email protected]>
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kaosine kaosine added enhancement New feature or request good first issue Good for newcomers modernization labels Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed modernization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants