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

external-applications.md: Add section on Steam #496

Merged
merged 1 commit into from
Apr 17, 2021

Conversation

cinerea0
Copy link
Contributor

This commit adds the relevant and current information from the Steam wiki page to the External Applications handbook page.

@cinerea0
Copy link
Contributor Author

cinerea0 commented Apr 2, 2021

@ericonr Is this something that would be considered for inclusion, or is the post-install message sufficient for documenting this?

Copy link
Member

@ericonr ericonr left a comment

Choose a reason for hiding this comment

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

I dislike having information split between places, so I'd prefer to have all of it either here or in void-packages. The information in void-packages I want to move to a README.voidlinux file, btw (this would also allow it to be more verbose, so some of the new text from here could go there).

@Chocimier what do you think? How should we determine what goes in void-docs and what goes in a readme file for the package?

Comment on lines 108 to 112
package; this should be enough for i686 systems. On x86_64 systems, additional
32-bit libraries must be installed. These libraries are listed upon installing
the `steam` package, and can be viewed in [Steam's install
message](https://github.com/void-linux/void-packages/blob/master/srcpkgs/steam/INSTALL.msg).
You will need to [enable](../config/services/index.md####enabling-services) the
Copy link
Member

Choose a reason for hiding this comment

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

Kind of unrelated, but I think we could add a tiny item to the XBPS part about seeing install msgs (xbps-query -p install-msg <package>), and this would link there instead of to the git repo.

@ericonr
Copy link
Member

ericonr commented Apr 3, 2021

After some more thinking, maybe the README could really only mention libraries and this section should mention the actual workarounds etc.

@Chocimier
Copy link
Member

How should we determine what goes in void-docs and what goes in a readme file for the package?

This is question about scope of void-docs, will leave decision to you.

Readmes can contain anything, no idea how far from "system components" like network or printing docs should go.

@cinerea0
Copy link
Contributor Author

@ericonr Can you elaborate on what the README.voidlinux files are or will be? That'll help a lot in me having an opinion on where things should go.

@ericonr
Copy link
Member

ericonr commented Apr 13, 2021

@cinerea0 see https://github.com/void-linux/void-packages/blob/master/Manual.md#void-specific-documentation and the existing README.voidlinux files in void-packages :)

The idea is to leave printing things to the terminal during installation for important messages, and have actual docs available but without bumping the actually important stuff from view :)

@cinerea0
Copy link
Contributor Author

cinerea0 commented Apr 14, 2021

@ericonr Okay, I think I understand. In that case, how about, in addition to the current info in the steam install message being moved to a README.voidlinux file, the information specific to the native package in the changes I proposed be moved there as well. I'd still like to keep a Steam section in the docs for the Flatpak version, with a reference to the README file for people using the native package, because the information we had in the wiki that I copied here appears to be difficult to find otherwise. Does that sound reasonable?

As a side note, I was unaware of the functionality of xbps-query you mentioned earlier. Do you think an overview of the -p option might be a valuable addition to the docs?

@ericonr
Copy link
Member

ericonr commented Apr 14, 2021

I think that does sound reasonable, yes!

As a side note, I was unaware of the functionality of xbps-query you mentioned earlier. Do you think an overview of the -p option might be a valuable addition to the docs?

Definitely! It's not exactly easy to find out about it :)

@cinerea0
Copy link
Contributor Author

cinerea0 commented Apr 15, 2021

@ericonr Alright, the proposed changes to the steam package have been merged into void-packages. Does the wording in my most recent push look okay?

src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
@cinerea0
Copy link
Contributor Author

@ericonr Alright, I've incorporated your changes. Also, I made sure check.sh passed before pushing, the error from Travis is just it being unable to contact zeroconf.org at the time.

src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
src/config/external-applications.md Outdated Show resolved Hide resolved
@cinerea0
Copy link
Contributor Author

cinerea0 commented Apr 17, 2021

Failing check is because it couldn't connect to libressl.org. God, travis sucks for connectivity. I ran check.sh locally before pushing and it didn't return any errors.

@ericonr
Copy link
Member

ericonr commented Apr 17, 2021

Great, thanks!

And yes, we should look into using GH actions.

@ericonr ericonr merged commit 9d573f8 into void-linux:master Apr 17, 2021
@cinerea0 cinerea0 deleted the steam branch April 18, 2021 00:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants