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

Better visibility / linkage of Astropy project elements #3661

Closed
taldcroft opened this issue Apr 3, 2015 · 6 comments
Closed

Better visibility / linkage of Astropy project elements #3661

taldcroft opened this issue Apr 3, 2015 · 6 comments

Comments

@taldcroft
Copy link
Member

I went to astropy.org looking for information about affiliated packages and for some reason my eyes didn't wander up to the top nav bar and so I didn't find it for a while. It is also not obvious that affiliated packages exist if you just go the core docs (hidden under Astropy at a glance => Overview).

The situation for Astropy tutorials seems even worse. I'm not sure how anyone is supposed to know these exist based on astropy.org or docs.astropy.org. (Again, I might have missed it, but I was actually looking, so there is room for improvement.)

The point here is to make it more obvious on astropy.org that this is the Project home page, and the Project is much more than the astropy core package.

Ideas:

  • Add sentences to the tagline in http://astropy.readthedocs.org/en/latest/index.html which reads something like: To learn about the Astropy project see <http://astropy.org>_. This includes information about Astropy tutorials <link> and affiliated packages <link>. (Note, use the http://astropy.org URL directly instead of as a link href so people see it and know it's there).
  • Add "Tutorials" to the astropy.org nav bar.
  • Perhaps also add buttons for Affliated Packages and Tutorials next to Current Documentation on the astropy.org index page, or else include something like the above additional sentences in the Astropy project tagline.
@embray
Copy link
Member

embray commented Apr 3, 2015

👍 Maybe this will help drive more development on tutorials again.

@embray
Copy link
Member

embray commented Apr 3, 2015

On the topic of giving astropy-tutorials more love, I'm a little concerned about this one: http://www.astropy.org/astropy-tutorials/FITS-header.html I feel like it's promoting practices that I'd rather users try to avoid. Maybe that's just me though.

@eteq
Copy link
Member

eteq commented Apr 21, 2015

@kelle volunteered to work on this at the Lorentz Center workshop

@bsipocz
Copy link
Member

bsipocz commented Apr 23, 2015

We also got the feedback, that it's not trivial to see that astropy does e.g. aperture photometry (through photutils). Would it make sense to brainstorm on how to get a better visibility for the affiliated packages? Googling on "photometry python" brings up the related docs page as the first find, but it's clearly not enough. Also the getting started pages and the list of affiliated packages are not on the first page of finds.

@kelle
Copy link
Member

kelle commented Apr 24, 2015

to be clear, I volunteered to work on adding links to the tutorials from the documentation.
I think the comment by @embray about FITS-Header should be a new issue in the tutorials repo.

@leahmfulmer
Copy link

Affiliated Packages are linked in the tagline at astropy.readthedocs.io/en/latest/index.html and tutorials are easy to find from astropy.org > Documentation > Tutorials. Issue closed by @adrn .

@adrn adrn closed this as completed May 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

7 participants