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

Webhost: Fix a typo on Start Playing page #3122

Merged
merged 2 commits into from
Apr 11, 2024

Conversation

ScipioWright
Copy link
Collaborator

What is this fixing or adding?

On the start playing page, it says "You'll need to upload either a config file or a zip file containing one more config files."
Instead of "one more", it should be "one or more".

How was this tested?

Standardized common core

If this makes graphical changes, please attach screenshots.

N/A

@github-actions github-actions bot added the affects: webhost Issues/PRs that touch webhost and may need additional validation. label Apr 9, 2024
@ScipioWright ScipioWright added is: bug/fix Issues that are reporting bugs or pull requests that are fixing bugs. and removed affects: webhost Issues/PRs that touch webhost and may need additional validation. labels Apr 9, 2024
@github-actions github-actions bot added the waiting-on: peer-review Issue/PR has not been reviewed by enough people yet. label Apr 9, 2024
@ScipioWright ScipioWright added the affects: webhost Issues/PRs that touch webhost and may need additional validation. label Apr 9, 2024
@PoryGone
Copy link
Collaborator

PoryGone commented Apr 9, 2024

Out of scope perhaps, but since you're in here, two things:

  1. Is "config file" a term we use for Player Option YAMLs anywhere else? It seems like an outdated term.
  2. The verbage here doesn't really capture the possibility of uploading multiple YAMLs together, not in a zip archive.

Copy link
Contributor

@Ixrec Ixrec left a comment

Choose a reason for hiding this comment

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

I could see "config file" being argued both ways since this text is aimed at people who are just learning AP for the first time, and jumping straight into Archipelago-specific jargon could be more intimidating than helpful.

Either way, the lack of "or" here is a pretty clear mistake we should fix.

@ScipioWright
Copy link
Collaborator Author

Out of scope perhaps, but since you're in here, two things:

1. Is "config file" a term we use for Player Option YAMLs anywhere else? It seems like an outdated term.

2. The verbage here doesn't really capture the possibility of uploading multiple YAMLs together, not in a zip archive.

For the sake of clarity, when uploading yamls to the site to generate a game, can you only upload player option yamls, or can you upload stuff like meta.yaml, host.yaml, or others I'm not thinking of too?

@PoryGone
Copy link
Collaborator

PoryGone commented Apr 9, 2024

For the sake of clarity, when uploading yamls to the site to generate a game, can you only upload player option yamls, or can you upload stuff like meta.yaml, host.yaml, or others I'm not thinking of too?

At the generation page, you can upload either:

  • Any number of player YAMLs at once, or
  • A zip containing any number of player YAMLs.

I could see "config file" being argued both ways since this text is aimed at people who are just learning AP for the first time, and jumping straight into Archipelago-specific jargon could be more intimidating than helpful.

I see where you're coming from, but I don't know that I see "config file" as so much more generic of a term that it's worth the subsequent confusion when they go any further than this specific page and never see the term again.

@ScipioWright
Copy link
Collaborator Author

I could see "config file" being argued both ways since this text is aimed at people who are just learning AP for the first time, and jumping straight into Archipelago-specific jargon could be more intimidating than helpful.

I see where you're coming from, but I don't know that I see "config file" as so much more generic of a term that it's worth the subsequent confusion when they go any further than this specific page and never see the term again.

I'll probably just do something along the lines of "a yaml file (player options configuration file)" to make it a little clearer to a first-time player.

@LegendaryLinux
Copy link
Member

I chose to use config as a generic term because something I would truly love is for normal users to never need to know what a YAML file is. Modifying them manually is in my opinion a power-user choice, or if it is not, it should be. Either way, I do not believe anyone is confused by the usage of the word "config."

I do agree the wording could be updated to reflect the possibility of uploading "one or more config files, or a single zip file containing one or more config files."

You'll need to upload either a config file or a zip file containing one more config files.
You'll need to upload one or more config files (YAMLs) or a zip file containing one or more config files.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I just committed a change here. Thoughts?

@LegendaryLinux LegendaryLinux merged commit ea4d0ab into ArchipelagoMW:main Apr 11, 2024
10 checks passed
@ScipioWright ScipioWright deleted the webhost-typo branch April 11, 2024 23:38
EmilyV99 pushed a commit to EmilyV99/Archipelago that referenced this pull request Apr 15, 2024
* add an or

* Changed the wording to account for uploading multiple files
EmilyV99 pushed a commit to EmilyV99/Archipelago that referenced this pull request Apr 15, 2024
* add an or

* Changed the wording to account for uploading multiple files
qwint pushed a commit to qwint/Archipelago that referenced this pull request Jun 24, 2024
* add an or

* Changed the wording to account for uploading multiple files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
affects: webhost Issues/PRs that touch webhost and may need additional validation. is: bug/fix Issues that are reporting bugs or pull requests that are fixing bugs. waiting-on: peer-review Issue/PR has not been reviewed by enough people yet.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants