QuantEcon / meta

For issues and discussion covering more than one repository
0 stars 0 forks source link

Add contributor page to each python lecture series? #6

Closed mmcky closed 4 years ago

mmcky commented 4 years ago

@jstac @thomassargent30 perhaps we can add a contributor page to each python lecture series as source/rst/contributors.rst and then update the current "see all contributors" to this page.

image

A page that is manually updated is probably more meaningful than the current github commit history - as a lot of that history is infrastructure related rather than content related.

sayaikegawa commented 4 years ago

Hi @mmcky , I'm going to make each rst file about contributors related to each repo. But seemingly I do not receive the list, if you have it, could you please put it here? Or would it be ok to make the files just from the current contributor page

mmcky commented 4 years ago

thanks @sayaikegawa -- my only hesitation is to have information in both places. @jstac do you think we should have a central place for contributors or a separate contributors page for each lecture series -> that is linked to from the front page (as I had suggested as a possible change above)?

mmcky commented 4 years ago

Or would it be ok to make the files just from the current contributor page

Yes - This would be the best information source for this work.

jstac commented 4 years ago

Well, this page is quite informative: https://quantecon.org/about-python-lectures/.

Is there a way to link to the heading "Credits"? Then perhaps "View all contributors" on each of the three pages should simply point to that?

Those who want to look up GH commit histories can do it easily enough. So we don't really need to point to it.

The "Credits" could be updated slightly by mentioning Saya, Harvey, Shu, Aakash and Juna as research assistants.

How does that sound @mmcky and @sayaikegawa ?

mmcky commented 4 years ago

@DrDrij is there a way to enable target / id tags for headings on the orgsite build?

mmcky commented 4 years ago

@jstac I think that is a nice idea. The orgsite is a jekyll build so we should be able to enable direct linking to title: Credit

sayaikegawa commented 4 years ago

@jstac , I think that is a nice idea too. I'll update it. Is Miles also RA to add the page? And should I add Harvey as co-author for cake-eating lecture?

DrDrij commented 4 years ago

@mmcky It should definitely be possible. An example would be changing the credits heading to:

## Credits {#credits}

You can then link directly so the page jumps to the heading with: https://quantecon.org/about-python-lectures/#credits

Source: https://www.markdownguide.org/extended-syntax/#heading-ids

Update It appears all the headings already have an id attached to them when converted to HTML. So we don't need to adjust the markdown. The link https://quantecon.org/about-python-lectures/#credits already jumps to the Credits heading. :)

image

mmcky commented 4 years ago

thanks @DrDrij that is helpful. I guess the rule of thumb is that section titles will always have an id but it is hard to know for mutli-word titles if the spaces are added or hyphened etc.

Is there a way to make a link indicator show up?

An example of what I mean is here:

https://www.sphinx-doc.org/en/master/intro.html#conversion-from-other-systems