HackMD
  • Beta
    Beta  Get a sneak peek of HackMD’s new design
    Turn on the feature preview and give us feedback.
    Go → Got it
      • Create new note
      • Create a note from template
    • Beta  Get a sneak peek of HackMD’s new design
      Beta  Get a sneak peek of HackMD’s new design
      Turn on the feature preview and give us feedback.
      Go → Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Please check the box to agree to the Community Guidelines.
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive Export to Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive Import from Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Export to Google Drive Gist
    Import
    Dropbox Google Drive Import from Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Please check the box to agree to the Community Guidelines.
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- tags: docs sprint --- # Jupyter docs alt text ## Test sprint on July 21, 2021 Welcome! Thank you for taking the time to help us test this sprint method and supporting accessible documentation. ### Agenda - 15 minutes-25: Sprint goal and process walkthrough - 25–45: Work time! - 45–50: Review PR - 50–60: Participant feedback ### How to particpate 1. Report to the team what page of the docs you plan to work on. 2. Write alt text for an image. 3. Submit that alt text on ~~[this PR](https://github.com/jupyterlab/jupyterlab/pull/10670)~~ [this PR](https://github.com/isabela-pf/jupyterlab/pull/1)via a [review comment suggestion](https://docs.github.com/en/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request). More [suggestion support here](https://nbviewer.jupyter.org/gist/tonyfast/0035d132c0c9162de4b3e66e3d596334). **Note:** If the image you want to add alt text to is not yet in the PR, tell Isabela and she can add it. 4. Repeat steps 2 and 4 as much as you'd like. Be sure to coordinate with others to avoid writing conflicting alt text. 5. Get review! Ask someone to review your alt text and make changes based on the feedback. 6. Hooray! You did it! ### JupyterLab docs - [Changelog](https://jupyterlab.readthedocs.io/en/stable/getting_started/changelog.html#v2-2-0) - [The JupyterLab interface](https://jupyterlab.readthedocs.io/en/stable/user/interface.html) - [Working with files](https://jupyterlab.readthedocs.io/en/stable/user/files.html) ### Alt text resources - [Alt decision tree](https://www.w3.org/WAI/tutorials/images/decision-tree/) (What kind of alt text does this image need?) - [Google developer documentation alt text style guide](https://developers.google.com/style/images#alt-text) (Documentation-focused alt text guidelines) - Examples at [Material Design](https://material.io/components/dialogs#usage) - Examples at [Carbon Design System](https://www.carbondesignsystem.com/components/UI-shell-left-panel/usage/) Coordination: - Tony: interface.rst (from bottom) - Mars: interface.rst (from top) - Isabela: changelog.md --- ### Participant feedback (fill in at end of call) - Commenting doesn't work in browser private modes - (Mike) Should we work on a fork rather than on main repo? Every suggestion will trigger a notification for folks.
 - Do drafts do notifications or not? It's probably safer to do it on a fork. - Can we claim by making a comment on the line and then editing it later? - For actual event, breakout rooms per file? - (Mike) Click on the … on markdown file for rich display to see the image as you are writing it. - If you don't do this from the start, this will delete your comment. - (Mike) Some of the screenshots are outdated. Is there a place we can note that it needs to be updated? Or double checked. - Can this be helped by Galata? - Is is still helpful to write "bad" alt text? Yes. - Make sure there is one PR from the start. No confusion. - (Mike) Include in guide https://jupyterlab.readthedocs.io/en/stable/developer/contributing.html#user-interface-naming-conventions - We need punctuation in the guide - Batch commit suggestions? - For example, each breakout room could have someone as the 'suggestion approver' who had some training in (upcoming) JupyterLab alt-text style guide. That way, approval of suggestions happens in batches of 3 people, instead of the main room of 12 people - This also maintains one fork. For example, 12 people, 3 breakout rooms. Less chaos because less overlapping. - Commit messages? Should they be standard too? - Spell check? - Maybe in introduction, have primer on JupyterLab interface so that people know what a screenshot is showing, especially in cropped images - Ugly example - ![](https://i.imgur.com/lGFcgJe.png) - So non-technical people understand what this screenshot is. - Alt-text: "A screenshot of JupyterLab and it's files" -> "A screenshot of the left sidebar with a few files" - ![](https://i.imgur.com/l9soFd3.png) - Is there an easy way to make sure we didn't miss any alt text items? - (Mike) Collaboratively review proposed alt text with :+1: and :-1: voting. - Need a break for future review - Copy editor at the end? - What do we need to do to wrap up the PR? - This time, Isabela reviewed and edited the PR post-accepted suggestions to ensure consistent style (kind of like a copy editor) and then made a clean PR to the main repo. - There wasn't much discussion around this PR, but since there is a goal to get this merged there could be other follow up work in this process depending on a specific project's review process.

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully