Skip to content

Commit

Permalink
Add/update alt text in documentation (#607)
Browse files Browse the repository at this point in the history
Co-authored-by: elichad <eli.chadwick.256@gmail.com>
Co-authored-by: MarsBarLee <46167686+MarsBarLee@users.noreply.github.com>
Co-authored-by: Annette Greiner <amgreiner@lbl.gov>
Co-authored-by: Peyton Murray <peynmurray@gmail.com>
Co-authored-by: R Ely <rebaely@gmail.com>
Co-authored-by: Maria Jose Molina Contreras <32220621+mjmolina@users.noreply.github.com>
Co-authored-by: franzenr <87659159+franzenr@users.noreply.github.com>
Co-authored-by: gabalafou <gabriel@fouasnon.com>
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu>
  • Loading branch information
11 people committed Jul 23, 2022
1 parent bed16d2 commit 2176bde
Show file tree
Hide file tree
Showing 14 changed files with 107 additions and 64 deletions.
2 changes: 1 addition & 1 deletion docs/source/community/community-call-notes/2019-may.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Add your potential agenda item here **24 hours before** the meeting at the lates
* 6.0 release of notebook?
* post jupyterlab 1.0?
* Qt(5.6)-based PDF output from JupyterLab (0.35)
Quick demo of using QtWebEngine to load a notebook in lab and make a PDF. $_{n+1}$th time's the charm! [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/deathbeds/nbconvert-pdfqt/master?urlpath=lab%2Ftree%2Fnotebooks%2Findex.ipynb) | [issue](https://github.com/jupyter/nbconvert/issues/1031) | [repo](https://github.com/deathbeds/nbconvert-pdfqt) | [name=Nick]
Quick demo of using QtWebEngine to load a notebook in lab and make a PDF. $_{n+1}$th time's the charm! [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/deathbeds/nbconvert-pdfqt/master?urlpath=lab%2Ftree%2Fnotebooks%2Findex.ipynb) | [issue](https://github.com/jupyter/nbconvert/issues/1031) | [repo](https://github.com/deathbeds/nbconvert-pdfqt) | [name=Nick]

## Attendees

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This is a place to make short announcements (without a need for discussion).
> Add agenda items here **before** the meeting. We will reorganize the agenda so that it fits in the 60m meeting slot.
* **WXYZDVCS** Work-in-progress report on [`wxyz.dvcs`](https://github.com/deathbeds/wxyz), a bridge from Jupyter Widgets to distributed version control - _Nick_
* _Hopefully_ released this week 🤞, [![][binder]](https://mybinder.org/v2/gh/deathbeds/wxyz/master?urlpath=lab/tree/src/py/wxyz_notebooks/src/wxyz/notebooks/index.ipynb) works though!
* _Hopefully_ released this week 🤞, [![Launch Binder]](https://mybinder.org/v2/gh/deathbeds/wxyz/master?urlpath=lab/tree/src/py/wxyz_notebooks/src/wxyz/notebooks/index.ipynb) works though!
* Pierre's notebooks for teaching Python and data science
* [JupyterLab Classic](https://github.com/jtpio/jupyterlab-classic) - *Jeremy*

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is a place to make short announcements (without a need for discussion).

Add agenda items here **before** the meeting. We will reorganize the agenda so that it fits in the 60m meeting slot.

* 🦌 [IPyElk 0.2.0](https://github.com/jupyrdf/ipyelk) [![binder-badge](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyrdf/ipyelk/42db3e3?urlpath=lab%2Ftree%2Fexamples%2F_index.ipynb)
* 🦌 [IPyElk 0.2.0](https://github.com/jupyrdf/ipyelk) [![Launch Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyrdf/ipyelk/42db3e3?urlpath=lab%2Ftree%2Fexamples%2F_index.ipynb)
* > Jupyter Widgets for interactive graphs _at scale_ powered by the [Eclipse Layout Kernel (ELK)](https://github.com/kieler/elkjs), [sprotty](https://github.com/eclipse/sprotty), [networkx](https://networkx.github.io).
* [dgaf](https://github.com/deathbeds/dgaf) (deathbeds generalized automation framework)
Expand Down
4 changes: 2 additions & 2 deletions docs/source/community/community-call-notes/2021-april.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For more discussion on the format of these calls, see the thread [here](https://
- **Gonzalo** Internationalization workflow for extension developers

- Some feedback... :man-facepalming:
- ![Text asking why there is a delay for publishing the language packs needed for internationalization](https://i.imgur.com/mho6Ka9.png)
- "As I see, there is a delay with the creation and publishing of language packs. We use Jupyter Lab as a base for one of our products and we are interested in using language lacks in it (especially Chinese and Japanese. What is the reason for the delay and is it possible to help the project somehow? We are interested in contributing to the Jupyter Lab project in many domains, for example, sofrware development, testing and translation."

- Releasing language packages :world_map::card_file_box:
- [Current packages and state](https://crowdin.com/project/jupyterlab) (showing first 10)
Expand All @@ -52,7 +52,7 @@ For more discussion on the format of these calls, see the thread [here](https://
- **Nbterm**
- [Blog: Jupyter Notebooks in the terminal](https://blog.jupyter.org/nbterm-jupyter-notebooks-in-the-terminal-6a2b55d08b70)
- [Github Repository](https://github.com/davidbrochart/nbterm)
![Notebook cell input and outputs represented in the terminal](https://i.imgur.com/kzNyCno.png)
![Notebook cell input and outputs represented in the terminal. The terminal has a black background and syntax coloring. Line numbers appear to the left of each line as "In 1", "In 2" etc. Inputs appear as text within a grey bounding box. Each input line's output appears as grey text below the box.](https://i.imgur.com/kzNyCno.png)

## Other Links Shared

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
===============
How can I help?
===============
# How can I help?

.. contents:: Contents
:local:
```{contents} Contents
:local:
```

Contributing to open source can be a nerve-wrecking process, but don't worry
everyone on the Jupyter team is dedicated to making sure that your open source
Expand All @@ -20,8 +19,7 @@ a small amount of the code necessary to fix the issue you are tackling. Any and
all help is welcome and any and all people are encouraged to contribute.


Submitting Pull Requests
========================
## Submitting Pull Requests

Individuals are welcome, and encouraged, to submit pull requests and contribute
to the Jupyter source. If you are a first-time contributor looking to get
Expand All @@ -31,8 +29,9 @@ is particularly useful because the Jupyter codebase is scattered across several
repositories within the jupyter organization, as opposed to a single
repository. You can click the link below to find sprint-friendly issues.

`is:issue is:open is:sprint-friendly user:jupyter
<https://github.com/search?q=is%3Aissue+is%3Aopen+is%3Asprint-friendly+user%3Ajupyter&type=Issues&ref=searchresults>`_
```{link-button} https://github.com/search?q=is%3Aissue+is%3Aopen+is%3Asprint-friendly+user%3Ajupyter&type=Issues&ref=searchresults
:text: is:issue is:open is:sprint-friendly user:jupyter
```

Once you've found an issue that you are eager to solve, you can use the guide
below to get started. If you experience any problems while working on the
Expand All @@ -46,9 +45,9 @@ including partial or in-progress work, is appreciated.

1. Fork the repository associated with the issue you are addressing and clone
it to a local directory on your machine.
2. `cd` into the directory and create a new branch using `git checkout -b insert-branch-name-here`.

2. ``cd`` into the directory and create a new branch using ``git checkout -b
insert-branch-name-here``. Pick a branch name that gives some insight into
Pick a branch name that gives some insight into
what the issue you are fixing is. For example, if you are updating the text
that is logged out by the program when a certain error happens you might
name your branch `update-error-text`.
Expand All @@ -60,7 +59,7 @@ including partial or in-progress work, is appreciated.
reside and leave a comment in the file describing what issue you are trying
to address.

5. Open a pull request to the repository with ``[WIP]`` appended to the front
5. Open a pull request to the repository with `[WIP]` appended to the front
so that the core team is aware that you are actively pursuing the issue.
When creating a pull request, make sure that the title clearly and concisely
described what your code does. For example, we might use the title "Updated
Expand All @@ -76,7 +75,7 @@ including partial or in-progress work, is appreciated.
6. Run the test suite locally in order to ensure that everything is properly
configured on your system. Refer to the repository's README for information
on how to run the test suite. This will typically require that you run the
``nosetests`` command on the commandline. Alternatively, you may submit a
`nosetests` command on the commandline. Alternatively, you may submit a
pull request. Our Continuous Integration system will test your code and
report test results.

Expand All @@ -101,7 +100,7 @@ including partial or in-progress work, is appreciated.
8. Go back to the file that you are updating and begin adding the code for your
pull request.

9. Run the test suite again to see if your changes have caused any of the test
9. Run the test suite again to see if your changes have caused any of the test
cases to pass. If any of the test cases have failed, go back to your code
and make the updates necessary to have them pass.

Expand All @@ -118,49 +117,47 @@ including partial or in-progress work, is appreciated.
12. Once your PR is ready to become a part of the code base, it will be merged
by a member of the core team.

Contribution Workflow
---------------------
.. image:: ../../_static/_images/contribution_workflow.png
## Contribution Workflow

```{image} ../../_static/_images/contribution_workflow.png
:alt: A flow chart listing the steps of contributing code to Jupyter with 14 labeled boxes linked by arrows. The chart is uni-directional. At each step, arrows point forward to one or more boxes and back to the previous box or boxes. Refer to the link below the image for full text.
```

Full Contribution Workflow description.[^f1]

Core Developer Workflow
-----------------------
## Core Developer Workflow

To help you understand our review process by core developers after you submit a
pull request, here's a guide that outlines the general process (specifics may
vary a bit across our repositories). Here is an example for Jupyter notebook
4.x:
`4.x`:



In general, Pull Requests are against ``master`` unless they only affect a
In general, Pull Requests are against `master` unless they only affect a
backport branch. If a PR affects master and should be backported, the general
flow is:

0. mark the PR with milestone for the next backport release (4.3)
1. merge into master
2. backport to 4.x
3. push updated 4.x branch
1. mark the PR with milestone for the next backport release (4.3)
2. merge into master
3. backport to 4.x
4. push updated 4.x branch

Backports can be done in a variety of ways, but we have `a script
<https://github.com/ipython/ipython/blob/master/tools/backport_pr.py>`_ for
Backports can be done in a variety of ways, but we have [a script](https://github.com/ipython/ipython/blob/master/tools/backport_pr.py) for
automating the common process to:

1. download the patch ` e.g. <https://patch-diff.githubusercontent.com/raw/jupyter/notebook/pull/1645.patch>`
2. checkout the 4.x branch
3. apply the patch
4. make a commit
1. download the patch ` e.g. <https://patch-diff.githubusercontent.com/raw/jupyter/notebook/pull/1645.patch>`
2. checkout the 4.x branch
3. apply the patch
4. make a commit

which works for simple cases, at least.

In this case, it would be:

python /path/to/ipython-repo/tools/backport_pr.py jupyter/notebook 4.x 1645

```
python /path/to/ipython-repo/tools/backport_pr.py jupyter/notebook 4.x 1645
```

Submitting a Bug
=================
## Submitting a Bug

While using the Notebook, you might experience a bug that manifests itself in
unexpected behavior. If so, we encourage you to open issues on GitHub. To
Expand All @@ -178,7 +175,7 @@ you take the following steps before submitting an issue.
in, in order to aid in the debugging of the issue. You will need to provide
information about the Python version, Jupyter version, operating system,
and browser that you are using when submitting bugs. You can also use
``pip list`` or ``conda list`` and ``grep`` in order to identify the
`pip list` or `conda list` and `grep` in order to identify the
versions of the libraries that are relevant to the issue that you are
submitting.

Expand All @@ -188,10 +185,42 @@ you take the following steps before submitting an issue.
5. Prepare an explanation of why the current behavior is not desired and
what it should be.

Reporting a Vulnerability
=========================
## Reporting a Vulnerability

If you believe you've found a security vulnerability in a Jupyter project,
please report it to `security@ipython.org <mailto:security@ipython.org>`_. If you
prefer to encrypt your security reports, you can use `this PGP public
key <https://jupyter-notebook.readthedocs.io/en/stable/_downloads/1d303a645f2505a8fd283826fafc9908/ipython_security.asc>`_.
please report it to [`security@ipython.org`](mailto:security@ipython.org).
If you prefer to encrypt your security reports, you can use [this PGP public key](https://jupyter-notebook.readthedocs.io/en/stable/_downloads/1d303a645f2505a8fd283826fafc9908/ipython_security.asc).

[^f1]: A flow chart with 14 labeled boxes linked by arrows.

The chart is uni-directional. At each step, arrows point forward to one or more boxes and back to the previous box or boxes. Here the flow chart is described as lists in which the possible next steps are listed beneath each box label.

1. Start
1a. forward to 'Find an issue to address'
2. Find an issue to address
2a. forward to 'Identify the relevant section of the codebase'
3. Identify the relevant section of the codebase
3a. forward to 'Write simple test cases to verify that your fix or enhancement works.'
4. Write simple test cases to verify that your fix or enhancement works.
4a. forward to 'Implement the bug fix or enhancement in the appropriate location'
5. Implement the bug fix or enhancement in the appropriate location.
5a. Forward to 'Run the test suite and verify that the updated code works appropriately.'
6. Run the test suite and verify that the updated code works appropriately.
6a. forward to 'Test suit passes!'
6b. forward to 'Test suit fails!'
7. Test suit fails
7a. forward to 'Identify and fix any issues in the new code that might be causing errors. Refer to the mailing list or Gitter channel for help.'
8. Identify and fix any issues in the new code that might be causing errors. Refer to the mailing list or Gitter channel for help.
8a. back to 'Run the test suite and verify that the updated code works appropriately'
9. Test suit passes!
9a. forward to 'Submit a pull request to the appropriate repository with your awesome code!'
10. Submit a pull request to the appropriate repository with your awesome code!
10a. forward to 'Reviewer approves and merges the PR'
10b. forward to 'Reviewer responds with changes you should make to the PR'
11. Reviewer responds with changes you should make to the PR
11a. forward to 'Apply the necessary fixes or updates to the pull request'
12. Apply the necessary fixes or updates to the pull request'
12a. back to 'Submit a pull request to the appropriate repository with your awesome code!'
13. Reviewer approves and merges the PR'
13a. forward to 'Rejoice and repeat!'
14. 'Rejoice and repeat!'
6 changes: 3 additions & 3 deletions docs/source/contributing/docs-contributions/doc-new-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,21 @@ project documentation whenever a pull request is merged into the GitHub repo.

Each GitHub repo has a Settings tab at the far right of the repo menubar. Navigate to Settings and then the **Webhooks & services** submenu tab.

![Settings and Webhooks & services submenu](static/gh-webhooks-services.png "Screenshot of GitHub repo settings")
![The ipywidgets GitHub repository's "Settings" tab has been opened, with the "Add service" submenu expanded. The "ReadTheDocs" menu item is highlighted to indicate where on the page this setting can be found.](static/gh-webhooks-services.png)

### Add the ReadTheDocs service

Select **Add service** and enter *ReadTheDocs* in the **Available Services** input box.

The Services/Add ReadTheDocs window will open. Press the green **Add service** button to activate the ReadTheDocs service.

![Add ReadTheDocs service](static/gh-add-rtd.png "Screenshot of adding ReadTheDocs service")
![In GitHub, the "Settings" tab of the ipywidgets repository shows that the "ReadTheDocs" service was successfully added to the project. A checkbox with the label "Active" indicates that the service is currently running.](static/gh-add-rtd.png)

### Success

The ReadTheDocs service is added successfully. The service will take effect on the next merged pull request to the project repo.

![Service successfully added](static/gh-rtd-hook-success.png "Screenshot of service successfully added")
![In GitHub, the ipywidgets repository page is open. A banner notification at the top of the page is displayed, reading "Okay, that hook was successfully created."](static/gh-rtd-hook-success.png)


*Created: 01-07-2016*
7 changes: 3 additions & 4 deletions docs/source/contributing/docs-contributions/doc-new-repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ On a larger scope, having the Jupyter name appear prominently in a repo's
### Link in repo description
Please include a link to the documentation in the repo's description.

![Repo description and documentation link](static/repo-description.png "Screenshot of documentation link in GitHub repo description")
![Documentation link in GitHub jupyter/notebook repo description annotated with a red speech bubble reading "Add link to documentation (usually a link to Read the Docs.)")](static/repo-description.png)

### Badges in README
One common way that individuals find documentation is to look for and click
on the doc badge that commonly is found right after the title. Another
benefit is an easy visual indication if the docs are not rendering properly.

![Badges in README.md](static/repo-badges.png "Screenshot of badges displayed under the repo title in the README file")
![The GitHub-rendered view of the README.md file for the Jupyter Notebook project is annotated with a red speech bubble reading "Add badge for Docs."](static/repo-badges.png)

### Resources section in README

Expand All @@ -27,9 +27,8 @@ information to users about the individual project and the larger Project
Jupyter organization. Make sure to include any links to the individual project's
demo notebooks, if available.

The *Resources* section includes:
For example, here is the [Resources section from jupyter/notebook]:(https://github.com/jupyter/notebook/blob/master/README.md#resources)

![Resources section in `README.md`](static/repo-resources.png "Screenshot of resource list at end of README file")


## Checklist adding docs to a new or existing GitHub Repo
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@ in the workflow described below. This workflow has a handful of actors and compo

### The translation process

![Translation CI/CD](static/translation-ci-cd.png "Diagram of the translation continuous integration
and deployment flow")
![](static/translation-ci-cd.png)

<!---Alt text is intentionally left blank because the image content is described thoroughly in the surrounding text.--->

1. A user creates or edits reStructuredText (`.rst`) or Markdown (`.md`) documents written in U.S.
English.
Expand Down Expand Up @@ -372,8 +373,7 @@ ReadTheDocs will build both the source documentation site as well as sites for a
languages. ReadTheDocs will associate the sites with one another and make them accessible via
language links in a popup.

![ReadTheDocs popup](static/translation-rtd-popup.png "Screenshot of the ReadTheDocs popup that
allows a user to view documentation in a different language")
![Project Jupyter documentation site with the ReadTheDocs popup open on the right, showing links to the documentation in other languages.](static/translation-rtd-popup.png)

## Reference

Expand Down
Loading

0 comments on commit 2176bde

Please sign in to comment.