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

Weekly Team Meetings: Oct-Dec 2023 #3

Open
ericsnekbytes opened this issue Oct 4, 2023 · 11 comments
Open

Weekly Team Meetings: Oct-Dec 2023 #3

ericsnekbytes opened this issue Oct 4, 2023 · 11 comments
Labels
weeklies Weekly meeting note summary issues

Comments

@ericsnekbytes
Copy link
Collaborator

ericsnekbytes commented Oct 4, 2023

Here is a record of the agenda/minutes for our weekly meeting. Everyone is welcome to join.

Navigation:

Let's avoid using this thread for discussion. If you'd like to discuss something in the minutes, open a separate issue and reference this thread.

@ericsnekbytes
Copy link
Collaborator Author

October 4, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Frederic Collonval QuantStack @fcollonval
Carlos Brandt CUB @chbrandt
Mike Krassowski Quansight @krassowski
Rosio Reyes Anaconda @RRosio

Agenda

  • Charter
    • Added initial draft charter. #2
    • Communicate: Give a holistic view of "what is jupyter?"
      • Communication channels of this ecosystem
        • many disparate channels
        • connect the dots!
        • related to "get help" effort?
    • Bot for linking back to discourse on github
      • lab, frequently asked questions section
        • can populate from discourse / bot
        • embed links to readthedocs, faq section in the docs
        • script for adding links to hot topics/questions on discourse onto that page
        • need examples to help illustrate "not just docs"
        • put docs into lab application itself / link to readthedocs (put into charter/multiple delivery points)
          • make extension(s) for this
          • notebook + lab, deliver 100% of docs (through a specific package)... libre office does this, offline docs package (see link Help for offline use)
          • side note: https://github.com/jupyter/papyri is one technical approach which is being developed within Jupyter (not necessarily the approach the working group needs to take, for interface documentation we would probably want something on a different level)
            • but maybe we should possibly assist with integrtation of papyri (decisions to be made)
    • meta docs are an important area to focus on
      • modular architecture makes documentation difficult, to communicate concepts across projects
  • Mission/Goals
  • Volunteers for first work items

@ericsnekbytes
Copy link
Collaborator Author

ericsnekbytes commented Oct 12, 2023

October 11, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Ana Ruvalcaba Cal Poly State University @Ruv7
Carlos Brandt Constructor University @chbrandt
Mike Quansight @krassowski
Frederic Collonval QuantStack @fcollonval
Rosio Reyes Anaconda @RRosio

Agenda

  • Eric G
  • Mike
    • docs repo vs jupyter repository.
      • Maybe rename docs to docs-team-compass/documentation-team-compass?
      • Where should the docs live?

@ericsnekbytes
Copy link
Collaborator Author

October 18, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt CUB @chbrandt
Mike Quansight @krassowski
Rosio Reyes Anaconda @RRosio

Agenda

  • Carlos

    • Define first tasks
    • Issues 8 and 12 are related
  • Eric G

    • Charter split
    • "Guide Book" here
      • Go through "original discussions", see issue, and look for points to add to the guide book
    • Repo rename to docs-team-compass
    • Characterize how documentation works in different subprojects (docs-in-code/docs on readthedocs, what automated systems are being used, etc.), make an issue
    • Diataxis, add to guide book
    • Merge Charter and Guide Book

@chbrandt
Copy link
Collaborator

October 25, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt CUB @chbrandt

Agenda

  • Eric G
  • Carlos
    • Started the compilation of docs of the subprojects
      • https://github.com/chbrandt/docs-team-compass/blob/main/subprojects_elements.md
      • listing documentations (rtd, sources)
      • listing repositories in orgs related to the projects (eg, example_extensions) for futre check against released docs
      • listing canonical distributions (eg from pypi)
      • dynamic relationships shown from project metadata
        • Some things are not gonna be obvious right away
          • Key design decisions that became principles
            • Why is Juptyer extensible? for example
              • from ipython days, was meant to make that interface extensible
              • magics are extensible, for instance
              • allow people ways to build their dissertation, was an early driver of extensibility
            • Can try to document these alongside history
            • "User always wins" for configs, design decision (users are not always in an environment they can control) is another example of a design principle that evolved

@chbrandt
Copy link
Collaborator

November 1, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes

Agenda

  • Time zone difference, probably everyone forgot ;)
  • Eric G
    • Moots!
    • Voting Criteria
    • Founding members

@chbrandt
Copy link
Collaborator

November 8, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt Constructor University @chbrandt
Rosio Reyes Anaconda @RRosio

Agenda

  • Eric G

    • Moots!
      • Formalize a way/process for convening one of these
    • Voting Criteria
    • Founding members
  • Carlos

    • What is Jupyter start: PR #23
    • Started working on the History of Jupyter doc

@chbrandt
Copy link
Collaborator

November 15, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt Constructor University @chbrandt
Rosio Reyes Anaconda @RRosio

Agenda

@chbrandt
Copy link
Collaborator

November 29, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt Constructor Uni @chbrandt

Agenda

Notes

@chbrandt
Copy link
Collaborator

December 6, 2023

name org username
Eric Gentry Anaconda @ericsnekbytes
Carlos Brandt Constructor University @chbrandt
Rosio Reyes Anaconda @RRosio

Agenda

  • Eric G
    • Go to EC (Executive Council) for recognition, maybe in new year?

Notes

  • Async place for DWG work, support, community engagement
    • not everyone is github savvy/software eng
    • zuloup (matrix?), discourse
  • Docs event in January?
    • Keyboard and alt text events
    • what new features can we try/add for no-mouse?
    • Pre, meeting, post work
      • What are we interested in? Make PRs for areas to focus on
      • During, do PRs
      • After, review and get it in
  • Get git out of the way (so ppl can contrib without having software eng knowledge)
  • DWG is making doors for people

@chbrandt
Copy link
Collaborator

December 13, 2023

name org username
Carlos Brandt Constructor University @chbrandt
Matthias Bussonnier Quansight @Carreau
Eric Gentry Anaconda @ericsnekbytes
Rosio Reyes Anaconda @RRosio

Agenda

  • Eric G
    • Jupyter Executive Council (EC) acceptance!
      • Issue here
      • Please come to the meeting Thurs 10AM PST
  • Carlos
    • How to improve re-use use of documentation chunk across Jupyter docs so we avoid duplication?
      • For example: consider the block about computational notebooks in JupyterLab docs frontpage:

        A computational notebook is a shareable document that combines computer code ...

        This text is copy-and-pasted from Jupyter Notebook docs.

        • Is there a way we could embed the whole block from Notebook to Lab's documentation?
      • The problem:

        • More work when updating such information if/when necessary
        • Hard to keep track of those duplicates (demands deep knowledge of the docs, likely to be in the heads of the core developers)
          • External contributors would have to update multiple instances of the same issue, with assistance of developers from multiple projects (in this case, Jupyter Lan and Notebook teams)
      • The benefits:

        • Simplifies the maintenance of the content by having one source (in the example: Jupyter Notebook docs)
          • Eventually, (depending on the solution) the new version will be propagated to the child pages (in this example, JupyterLab docs frontpage)
      • Solution requirements:

        • (External) contributors willing to fix/update the documentation, they must know where it is coming from.
          • One way is to make it clear in the final HTML (eg, whole block under a hyperlink, or a link next to it)
          • Another way: the source of information would be defined in the raw file
      • Side effects:

        • Complexity in the documentation building system

@chbrandt
Copy link
Collaborator

December 20, 2023

name org username
Carlos
Mike
Nick

Agenda

@ericsnekbytes ericsnekbytes added the weeklies Weekly meeting note summary issues label Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
weeklies Weekly meeting note summary issues
Projects
None yet
Development

No branches or pull requests

2 participants