search

w3c / wai-people-use-web

25 stars 60 forks source link

Pre-publication checklist #323

Closed brianelton closed 2 months ago

brianelton commented 5 months ago

for publication:

with publication:

before announcing:

with or soon after publication:

soon though not publication blocking: moved to https://github.com/w3c/wai-website/issues/541

remibetin commented 2 months ago

@brianelton @shawna-slh I guess we also need to remove the "draft" banner in https://deploy-preview-113--wai-people-use-web.netlify.app/people-use-web/?

remibetin commented 2 months ago

@brianelton @shawna-slh

I have looked at the PR and have some questions that I think need to be resolved before publication:

  1. There are two files for "Diverse Abilities and Barriers". Which one to keep; which one to delete?

  2. The PR includes 3 pages with video playlists. Do you intend to publish them? They do not seem ready to publish.

  3. The individual stories' filenames and slugs (user-stories-one, user-stories-two, etc.) seem a little obscure to me. Are they temporary, or the final slugs/filenames you want to use? What do you think of this alternative: ade-story, ian-story, etc. ?

  4. More broadly, I am a bit confused by the URL structure in this resource:

- people-use-web/user-stories/
 - people-use-web/user-stories-one/
 - people-use-web/user-stories-two/
 - ...
- people-use-web/abilities-barriers/
  - people-use-web/abilities-barriers-auditory/
  - people-use-web/abilities-barriers-physical/
  - ...
- people-use-web/tools-techniques/
  - people-use-web/tools-techniques-perception/
  - people-use-web/tools-techniques-presentation/
  - ...

I suggest the following URLs, that would bring more consistency with the current structure used throughout the website:

- people-use-web/user-stories/
 - people-use-web/user-stories/abe-story/
 - people-use-web/user-stories/ian-story/
 - ...
- people-use-web/abilities-barriers/
  - people-use-web/abilities-barriers/auditory/
  - people-use-web/abilities-barriers/physical/
  - ...
- people-use-web/tools-techniques/
  - people-use-web/tools-techniques/perception/
  - people-use-web/tools-techniques/presentation/
  - ...

  1. This page seems to be a draft version: https://deploy-preview-113--wai-people-use-web.netlify.app/people-use-web/user-stories-with-video/ Is it deprecated now?

  2. What about the files in the video folder? Were they used solely for test purposes? https://github.com/w3c/wai-people-use-web/tree/2021-revision/_people-use-web/video

remibetin commented 2 months ago

I have just noticed an open issue is related to my 3rd question: https://github.com/w3c/wai-website/issues/535

I would like to challenge that this is low priority: changing URLs is always tricky. I think more reasonable to choose a better pattern before the first publication.

shawna-slh commented 2 months ago

@iadawn We need you to weigh in on several of these.

remibetin commented 2 months ago

FYI, I have opened 2 PRs in wai-website-data repository:

Update 24 June: I am now using a single PR for VTT files and navigation update: https://github.com/w3c/wai-website-data/pull/157

iadawn commented 2 months ago
  1. There are two files for "Diverse Abilities and Barriers". Which one to keep; which one to delete?

Keep the first one, delete the second (-alt)

  1. The PR includes 3 pages with video playlists. Do you intend to publish them? They do not seem ready to publish.

Can remove those

  1. The individual stories' filenames and slugs (user-stories-one, user-stories-two, etc.) seem a little obscure to me. Are they temporary, or the final slugs/filenames you want to use? What do you think of this alternative: ade-story, ian-story, etc. ?

Use the obscure ones. If you embed the names and the names change in the future then we introduce a problem.

  1. More broadly, I am a bit confused by the URL structure in this resource: 
    - people-use-web/user-stories/
- people-use-web/user-stories/abe-story/
- people-use-web/user-stories/ian-story/

Yes, with the proviso that it is story-one and not named.

 - ...
- people-use-web/abilities-barriers/
  - people-use-web/abilities-barriers/auditory/
  - people-use-web/abilities-barriers/physical/
  - ...
- people-use-web/tools-techniques/
  - people-use-web/tools-techniques/perception/
  - people-use-web/tools-techniques/presentation/
  - ...

Yes. Can't recall why they were all on one level.

  1. This page seems to be a draft version: https://deploy-preview-113--wai-people-use-web.netlify.app/people-use-web/user-stories-with-video/ Is it deprecated now?

Yes. This was to help with exploring the possible.

  1. What about the files in the video folder? Were they used solely for test purposes? https://github.com/w3c/wai-people-use-web/tree/2021-revision/_people-use-web/video

Yes.... I think so.

remibetin commented 2 months ago

Thank you @iadawn I have updated the PR accordingly.

See latest preview: https://deploy-preview-113--wai-people-use-web.netlify.app/people-use-web/

cc @brianelton @shawna-slh

shawna-slh commented 2 months ago

note to follow up on: What about compilation videos? created future enhancement issue https://github.com/w3c/wai-website/issues/533

remibetin commented 2 months ago

update annotated nav pages - https://github.com/w3c/wai-website/pull/518

Cannot be done with publication: depends on https://github.com/w3c/wai-website/issues/533

remibetin commented 2 months ago

@shawna-slh In this resource, the captions are not working when the video card component is used. I am investigating why.

remibetin commented 2 months ago

@shawna-slh I have found the problem: the VTT files were sometimes using a comma as decimal separator instead of a dot. Fixing now...

The files were also missing an initial "WEBVTT" line.

https://github.com/w3c/wai-website-data/pull/157/commits/2b1ce33e28b87777999f4019a3df5e95746a1c01 https://github.com/w3c/wai-website-data/pull/157/commits/2a7659ac818cb6214cd7603dadf1fb50eb292f3a

remibetin commented 2 months ago

FYI, I have added the "Acknowledgements" page to navigation (hidden by default): see https://deploy-preview-113--wai-people-use-web.netlify.app/people-use-web/acknowledgements/

https://github.com/w3c/wai-website-data/pull/157/commits/579c9721eeb260c88618f51aad3397c950ea14f1

shawna-slh commented 2 months ago

Cannot be done with publication: depends on https://github.com/w3c/wai-website/issues/533

Hey @remibetin I edited it for the current publication. Please let me know if anything seems not right. Thanks!

remibetin commented 2 months ago

@iadawn @brianelton @shawna-slh FYI, the content has been moved to wai-website repository, in the following folder: https://github.com/w3c/wai-website/tree/master/pages/fundamentals/people/people-use-web

remibetin commented 2 months ago

I am closing this pre-publication issue. I have opened a new issue for fixing links throughout the site: https://github.com/w3c/wai-website/issues/541