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
    Like3 BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    --- tags: NumPy --- # 2023-06-05 NumPy Documentation Team meeting - Time: 4 pm UTC - Join via Zoom: https://us06web.zoom.us/j/85016474448?pwd=TWEvaWJ1SklyVEpwNXUrcHV1YmFJQT09 (To dial in, find your local number: https://us06web.zoom.us/u/ksv5WeoUL) - [NumPy community events calendar](https://scientific-python.org/calendars/) - [Documentation issues](https://github.com/numpy/numpy/labels/04%20-%20Documentation) - [Documentation brainstorming document](https://hackmd.io/RdtnQZpLRZqgNRe4gaJ0SA) - anything that is not yet ready for an issue or PR or needs a discussion - [Documentation team meetings notes archive](https://github.com/numpy/archive/tree/main/docs_team_meetings) - [Community meetings notes archive](https://github.com/numpy/archive/tree/main/community_meetings) - [Triage meetings notes archive](https://github.com/numpy/archive/tree/master/triage_meetings) - Next meeting: 2023-06-19 @ 12 pm UTC ### Useful links - Getting started with building documentation: https://numpy.org/devdocs/dev/howto_build_docs.html - How to contribute to the NumPy documentation: https://numpy.org/devdocs/dev/howto-docs.html ### Code of Conduct We want to take a moment to remind you that this meeting is meant to be welcoming and inclusive. It's important for us to have a healthy community. Like all NumPy spaces, and everyone participating in them, this meeting will follow our [Code of Conduct](https://numpy.org/code-of-conduct/). If you haven't read it yet, please take some time to do so later on as it already applies to you. For now, in short, please be kind and generous towards one another. If you see violations, take a screenshot, intervene in a respectful manner, and report it to the CoC Committee via email. For more information, refer to the Reporting Guidelines section on https://numpy.org/code-of-conduct/. **Present:** Mukulika, Jules, Inessa **Notes taken by:** ## Standing topics - [name=inessa] Presentation topics for NumPy Newcomers’ Hour To suggest a topic for future presentations, leave a comment in this tracking issue: https://github.com/numpy/archive/issues/58. - Short form content? - [name=Inessa & Melissa] [Documentation user stories](https://github.com/numpy/numpy/issues/22089) *Feel free to add yours!* - Inessa: issues related to the NumPy educational content: https://github.com/numpy/numpy-newsletter/issues/20 https://github.com/numpy/numpy-newsletter/issues/24 https://github.com/numpy/numpy-newsletter/issues/25 https://github.com/numpy/numpy-newsletter/issues/26 If you’d like to work on any of them, leave a comment on GitHub (below the relevant issue). - Tracking inactive PRs: https://github.com/orgs/numpy/projects/6 (help with triaging is welcome!) ## Follow-up from last meeting / discussions - [name=rossbar] Dealing with data for NumPy tutorials * **Action item**: Start with scikit-learn data * Future SPEC? How to host data since every project is doing it's own thing * Core problem: No free infrastructure for data like there is for source code - Add to new document ideas: - Understanding NumPy striding while doing a transpose - We can use the xray dataset for the illustration - Best practices for random number generators for parallelization - Monte Carlo estimation for pi - possible example - A guide for common performance issue questions - Could be a Sphinx gallery for better discoverabilty - Speak to Pamphile about adding educational materials based on his recent academic papers: - https://joss.theoj.org/papers/10.21105/joss.05309 - https://arxiv.org/abs/2206.13470 - As a general pattern: be aware that scipy often has improved interfaces to things that are computed "by-hand" in numpy - [mattip] What is up with Sphinx 6? There is an open issue around the need to pin to sphinx 5, and breathe also requires sphinx5. In order to prove it is working, we need to actually deploy the docs which means merging the change to `main`, so we would have to do a controlled experiment on the devdocs deployment. * Related to the above: https://github.com/numpy/numpy/pull/23677 * Also, sphinx 7 is out: :scream: * Open up as contribution opportunity- testing with Sphinx 7 - Now at Outlining stage for GSOD-NumPy 2023 (May 15-26) - Completed Gathering community input stage and 3 brainstorming sesions - At Newcomer(May 4) NumPy Docs (May 8), Commmunity (May 10) - [Link to Google Jamboard](https://jamboard.google.com/d/1j_rEIslOh59N9cLGU1VGc7rTc88SuLTi7l4YqTqAULc/edit?usp=sharing) - [Summary from Brainstorming Sessions](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/outlining/summary-from-brainstorming-sessions.md) - Next steps - Narrow down [User Personas](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/outlining/user-persona-contributor-pathways.md) - Draw [Concept Art Prompts](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/outlining/concept-art.md) - Discussion points - Use of metaphor: to make a complicated topic friendly - Metaphor should not core topic (contributor workflow) make more complicated - User Persona: Could get input eg Twitter - Getting more user input would be best practice: but may not fit in timeline - Could do later, perhaps future review stage - Review stage - on NumPy github issues through mailing list, slack and community meeting channels. - Using Google Docs, since easier to comment on images than on Github PR - Reviews stage open for 2 weeks (late May-early June) - Letting go making full 'comic book style' - Due to time constraints, may not be able to make full flowing story panel to panel - May end up with blog style: informational images with text underneath to explain in more detail - Similar to [prototype](https://miro.medium.com/v2/resize:fit:720/format:webp/1*kwkvHzegb0z4TzeHsuF_GQ.png) - Less similar to [SciPy comics](https://heyzine.com/flip-book/f3c7f85cdc.html) - Especially since contributor workflow has several different scopes - Zoomed in scope, eg people working together during a sprint - Zoomed out scope, eg role of maintainers or community members - Several different characters: contributor workflow would probably need at least... 6 characters? Hard to sustain coherent script for 6 characters - Letting go of artist ego to fully utilize 'comic book' medium - Need to realistically rescope to fit in other important factors eg gathering community input, representing a relatively complex topic (contributor workflow) - Working more as a documentary movie rather than cinematic story-driven movie - The value is more in documenting processes and people rather than thrilling story or camera angles - Recognizing desire for print version is contributor factor to wanting a 'full comic experience' - Paper version needs to fit rectangular size, hence use of panels - Digital version can be any size, but we can keep to rectangular size - Digital version reach wider audience, especially outside conferences in North America ## New Topics - https://github.com/numpy/numpy/pull/23547 - review required. - https://github.com/numpy/doc/pull/15 - close? - Jules: Adding timestamps to YoutTube video: - https://github.com/numpy/numpy-newsletter/pull/22 - Broad chapters instead of minute-by-minute timestamps - Submit a markdown PR to the newsletter repo - Someone approves and submits to YouTube (needs access) An example of how to submit a PR with the timestamps: https://github.com/numpy/numpy-newsletter/pull/22/files --- ### Let's connect and keep the conversation going! Join the NumPy contributor community **Slack workspace**: https://join.slack.com/t/numpy-team/shared_invite/zt-1gokbq56s-bvEpo10Ef7aHbVtVFeZv2w Sign up to the NumPy **mailing list**: mail.python.org/mailman/listinfo/numpy-discussion Subscribe to the NumPy **YouTube** channel: https://www.youtube.com/c/NumPy_team Follow us on **Twitter**: [@numpy_team](https://twitter.com/numpy_team) Follow us on **LinkedIn**: https://www.linkedin.com/company/numpy/ --- Remember to archive this file by committing it to [https://github.com/numpy/archive/tree/main/docs_team_meetings](https://github.com/numpy/archive/tree/main/docs_team_meetings)

    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