Add text to the below the download buttons to explain what to do if you can't download zip files

GSA / openacr

OpenACR is a digital native Accessibility Conformance Report (ACR). The initial development is based on Section 508 requirements. The main goal is to be able to compare the accessibility claims of digital products and services. A structured, self-validated, machine-readable documentation will provide for this.

https://gsa.github.io/openacr/

Other

83 stars 18 forks source link

Add text to the below the download buttons to explain what to do if you can't download zip files #279

Closed danid123 closed 2 years ago

danid123 commented 2 years ago

[x] Add a line below the existing copy on the button. Download Report (YAML and HTML) .zip (centered)
[x] Add the following body copy below the button: Some agencies and corporations have a policy prohibiting the the download .of zip files. If your organization has a similar rule, you can complete the following steps to get a YAML and HTML file for sharing:
1. Download the YAML only file
2. Right click anywhere on this page and select Save As.
3. Choose a location where you want to save your HTML file.
4. Share the HTML file or folder and the YAML file you previously downloaded with your collaborators.
5. Let your collaborators know that they can view the HTML version of the file and can make edits by going to the OpenACR editor and uploading the YAML file. When they have completed their edits, they must to send you the YAML file but the HTML file is optional.

danid123 commented 2 years ago

@mgifford does this look ok to you?

I did notice that a lot of .gov sites also tell you the file size of the file you're downloading but I think that's a nice to have and not a requirement.

mgifford commented 2 years ago

Looks good to me. Thanks @danid123

Yes, the file size would be an optional thing. These are largely pretty small files.

In talking to an accessibility agency last week there was discussion about incorporating blockchain into the OpenACR file format. I didn't see that as a big enhancement. Likewise I can't see the need to have a MD5 hash of the files. If at some point OpenACRs get larger though, maybe these would be things to consider.

dmundra commented 2 years ago

@danid123 here is a screenshot of changes. I also added header.

screenshot of new download button

Does that match what you are looking for? Any changes before I submit the code?

danid123 commented 2 years ago

@dmundra It's missing the beginning paragraph, right above the numbered steps: "Some agencies and corporations have a policy prohibiting the the download .of zip files. If your organization has a similar rule, you can complete the following steps to get a YAML and HTML file for sharing:"

Even though it's kind of redundant I'm wondering if we do one of these options? @mgifford which one do you like best?

dmundra commented 2 years ago

Oops. Thanks @danid123 for catching that. I will fix that and the button tomorrow (one you have a button choice selected)

mgifford commented 2 years ago

I think #2 is best @danid123

Also I think we don't need to stress about the wording too much as once it is in place we can get feedback from users and tweak it.

But yes, something like:

Some agencies and corporations have a policy prohibiting the the download .of zip files. If you cannot download the .zip file you can download the YAML file by clicking the link above and save the HTML file convenient viewing by:

Right click anywhere on this page and select Save As.
Choose a location where you want to save your HTML file.
Share the HTML file or folder and the YAML file you previously downloaded with your collaborators.
Let your collaborators know that they can view the HTML version of the file and can make edits by going to the OpenACR editor and uploading the YAML file. When they have completed their edits, they must to send you the YAML file. The HTML file is optional.

dmundra commented 2 years ago

@danid123 and @mgifford I updated the download section https://gsa.github.io/openacr-editor/report#download-editor

bruce-usab commented 2 years ago

Thanks so much for surfacing this option and the extra bit of instruction!

Some agencies and corporations have a policy prohibiting the the download .of zip files. If your organization has a similar rule, you can complete the following steps to get a YAML and HTML file for sharing...