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.

Sign up for GitHub

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

Jump to bottom

Update homepage to be more readable and user-friendly #878

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Update homepage to be more readable and user-friendly #878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65bbeed
Add questions + emojis at top of homepage
paigem Sep 4, 2022
440e9f5
trim down homepage and direct folks to relevant pages
paigem Sep 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@
'sphinx.ext.mathjax',
'sphinx_copybutton',
'sphinxcontrib.bibtex',
'sphinxcontrib.srclinks']
'sphinxcontrib.srclinks',
'sphinx.ext.graphviz']

# -- GraphViz configuration ----------------------------------
graphviz_output_format = 'svg'

copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
copybutton_prompt_is_regexp = True
Expand All @@ -59,7 +63,7 @@

# General information about the project.
project = 'Pangeo'
copyright = '2018-2021, Pangeo Team'
copyright = '2018-2022, Pangeo Team'
author = 'Pangeo Team'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -115,7 +119,7 @@
# an arbitrary url.
'navbar_links': [
("Blog", "https://medium.com/pangeo", True),
("Forum", "https://discourse.pangeo.io", True),
("Discourse Forum", "https://discourse.pangeo.io", True),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure that adding 'Discourse' is really needed in the navbar.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that a longer name might be less useful, but Aimee and I both mentioned that we were confused about this terminology during our first few Pangeo website visits years ago. In my experience, most Pangeo folks refer to it as "Discourse" and in initially I didn't know that "Discourse" was a web forum.

Maybe we can get some others to weight in here, but I'd still vote for "Discourse Forum" in the navbar for extra clarity.

],
}

Expand Down
134 changes: 47 additions & 87 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,53 @@ Pangeo
.. image:: _static/pangeo_simple_logo.svg
:width: 175 px

A community platform for Big Data geoscience
============================================
A community promoting open, reproducible, and scalable geoscience
=================================================================

.. list-table::
:widths: 10 10 10 10 10
:header-rows: 1
:align: left

* - ❓ Have questions about Python software?
- 🤩 Want to hear about new updates to Pangeo software or infrastructure?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pangeo software: what is it? Pangeo ecosystem?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! Maybe Pangeo software is poorly defined. (Though we could like to the Pangeo Packages page, which also needs a serious update!)

I like your suggestion of "Pangeo ecosystem", as it encompasses more than just the software side of Pangeo. My only hesitation there is that the term is more vague. The table I added here is largely to steer people in the right direction quickly. It's hard to know, but I'd guess that a lot of visitors to the site are there to find quick answers to coding problems, in which case explicitly stating "software" instead of "ecosystem" might be more functional. My primary goal with this table is to address some of the most frequent questions our site visitors may have.

That all being said, happy to change to "ecosystem" if we think that's best! 😊

- 😃 Wondering how you can get involved in the Pangeo community?
- ☁️ Interested in getting access to Pangeo Cloud?
- 🧐 Just curious to learn more about Pangeo?
* - Search for answers or ask your own question on the `Pangeo Discourse Forum <https://discourse.pangeo.io/>`_!
- Check out our `Medium blog <https://medium.com/pangeo>`_ and our `Twitter feed <https://twitter.com/pangeo_data>`_!
- Post or answer questions in the `Pangeo Discourse Forum <https://discourse.pangeo.io/>`_, attend a `community meeting <https://pangeo.io/meeting-notes.html>`_, or start issues/create pull requests on our `GitHub repos <https://github.com/pangeo-data/>`_!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Post or answer questions in the `Pangeo Discourse Forum <https://discourse.pangeo.io/>`_, attend a `community meeting <https://pangeo.io/meeting-notes.html>`_, or start issues/create pull requests on our `GitHub repos <https://github.com/pangeo-data/>`_!
- Post or answer questions in the `Pangeo Discourse Forum <https://discourse.pangeo.io/>`_, attend a `community meeting <https://pangeo.io/meeting-notes.html>`_, or open issues/create pull requests on our `GitHub repos <https://github.com/pangeo-data/>`_!

- Fill out the application form available on the `Pangeo Cloud site <https://pangeo.io/cloud.html>`_.
- Read about us on the `About Pangeo page <https://pangeo.io/about.html>`_.

..
This portion is currently commented out rather than deleted, because it appears that the "toctree" here may be
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, this is what sphinx uses to figure out which documents in the build (https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=toctree#table-of-contents).

Did you comment it out since you didn't want to include the toctree on the homepage? If you want, you can do something like

.. toctree::
   :hidden:

   about
   ...

to hide the toctree. I think we'd still want some way to navigate to those pages though, and I'm not sure how hidden interacts with the sphinx's navigation stuff.

necessary for the website (currently generates many errors). See note at top.

.. Contents
.. ^^^^^^^^

..
..
.. toctree::
.. :maxdepth: 1

.. about
.. faq
.. quickstart
.. packages
.. gallery
.. architecture
.. setup_guides/index
.. cloud
.. data
.. catalog
.. collaborators
.. publications
.. pangeo-showcase
.. meeting-notes
.. meetings/index
.. contact

.. image:: https://img.shields.io/github/contributors/pangeo-data/pangeo?logo=github&style=flat-square
:target: https://github.com/pangeo-data/pangeo
Expand All @@ -24,88 +69,3 @@ A community platform for Big Data geoscience
.. image:: https://img.shields.io/twitter/follow/pangeo_data?logo=twitter&style=flat-square
:target: https://twitter.com/pangeo_data
:alt: Twitter

This website contains general information about the Pangeo project.
For news and updates about Pangeo, check out our
`Medium blog <https://medium.com/pangeo>`_ and our
`Twitter feed <https://twitter.com/pangeo_data>`_.
To engage with the Pangeo community, head over to our
`Discourse forum <https://discourse.pangeo.io/>`_
or browse our `GitHub repos <https://github.com/pangeo-data/>`_.


.. raw:: html

<div class="row">
<div class="col-md-6 center-block">
<h2><a href="https://twitter.com/pangeo_data">Twitter Feed</a></h2>
<p class="text-center font-italic">We use twitter to share announcements and retweet content of interest to our community.</p>
<a class="twitter-timeline" data-width="100%" data-height="500" data-theme="light" data-link-color="#5eb130" href="https://twitter.com/pangeo_data?ref_src=twsrc%5Etfw">Tweets by pangeo_data</a> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
</div>
<div class="col-md-6 center-blockr">
<h2><a href="https://discourse.pangeo.io/">Discourse Forum</a></h2>
<p class="text-center font-italic">Discourse is a message board where we discuss all aspects of the project in a friendly, inclusive way.</p>
<div class="feedgrabbr_widget" id="fgid_d0649815dd692ed59cba2d8d0"></div>
<script>if (typeof (fg_widgets) === "undefined") fg_widgets = new Array(); fg_widgets.push("fgid_d0649815dd692ed59cba2d8d0");</script>
<script async src="https://www.feedgrabbr.com/widget/fgwidget.js"></script>
</div>
</div>

What is Pangeo?
===============

Pangeo is first and foremost a community promoting open, reproducible, and scalable science.
This community provides documentation, develops and maintains software, and deploys
computing infrastructure to make scientific research and programming easier.
The Pangeo software ecosystem involves
open source tools such as xarray, iris, dask, jupyter, and many other packages.
There is no single software package called "pangeo"; rather, the Pangeo project serves
as a coordination point between scientists, software, and computing infrastructure.
On this website, scientists can find guides for accessing data and performing analysis
using these tools (read the :ref:`quickstart`, browse the :ref:`use-cases`, and
learn about the :ref:`packages`).
Those interested in building infrastructure can find
instructions for deploying Pangeo environments on HPC or cloud clusters
(learn about the :ref:`architecture` or read the :ref:`setup-guides`).
For more general information, read :ref:`about`, see the :ref:`collaborators`,
or read the :ref:`FAQ`.
Welcome to the Pangeo community!

Our Goals
^^^^^^^^^

#. Foster collaboration around the open source scientific python ecosystem for
ocean / atmosphere / land / climate science.
#. Support the development with domain-specific geoscience packages.
#. Improve scalability of these tools to handle petabyte-scale datasets on
HPC and cloud platforms.

Pangeo Gallery
^^^^^^^^^^^^^^

Science applications and detailed tutorial for using Pangeo can be found in
`Pangeo Gallery <http://gallery.pangeo.io>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is important to have a Pangeo Gallery link somewhere in the homepage. Maybe in 'learn more' table section?



Contents
^^^^^^^^

.. toctree::
:maxdepth: 1

about
faq
quickstart
packages
gallery
architecture
setup_guides/index
cloud
data
catalog
collaborators
publications
pangeo-showcase
meeting-notes
meetings/index
contact