ponylang/ponylang-website

The ponylang.io website

ponylang-website's Issues

New Site: releases

We need a section to denote releases. I'm thinking its part of the blog.

Other ideas?

New site: How to triage

A guide for how to triage issues would be good part of contribute.

This would be both for committers (what labels do you apply when) but also general cases of how to narrow down to minimal cases. What additional info you should be asking for etc.

Goals...

• get committers working in sync with using labels and other triaging.
• help community members aid in developing pony via triaging

New site: Add stickers

URL: https://www.stickermule.com/user/1070743396/stickers

Note about "sold at cost".

Community? Somewhere else?

New site: Code of Conduct

Create a "generic" code of conduct page that we can link to from all other locations.

Once this is merged, we can update all groups.io and other links to point to a single, easy to maintain code of conduct.

Should we also update the COC's in various repos to point to this? I think yes.

Switch build system from travis based to Netlify based

We only use hugo to build the site. Netlify makes all versions of hugo easily available. The site will get updated quicker if we switch to building @ netlify rather than travis.

As part of this, we can also get nice previews of the site for PRs.

We can also move "source" branch to being "master" and not having a magic "this is the branch that the generated content lives on".

This will make this repo a "normal" repo with no magic special branches which is a good thing.

Tasks

• replace travis.yaml with netlify.toml
• move content of source branch to master
• update default branch for this repo to master
• make sure any documentation referring to "source" is updated to master.

THIS SHOULD NOT BE DONE WHILE PRs are outstanding

Some docstrings are missing

The Timers.create page
https://stdlib.ponylang.org/time-Timers/#create

Doe not include the docstring that appears in the 0.14 release

Create a timer handler with the specified number of slop bits. No slop bits
means trying for nanosecond resolution. 10 slop bits is approximately
microsecond resolution, 20 slop bits is approximately millisecond
resolution.

New site: Add RFC process to contribute

Add "pony playpen" to Discover section

http://playground.ponylang.org

New site: add groups.io dev wiki content to contribute section

This should all go into the contribute section:

https://pony.groups.io/g/dev/wiki

New Site: Blog

Still needed:

• support for tags
• social sharing buttons
• make date formatting look decent
• make category formatting look decent
• make overview page formatting look decent
• give a little love to category overview page
• expose /categories on site

New site: Art and fair usage

Add page with SVG's for Pony logo(s) and Main mascot.

Should include copyright notice (we have not given that up) and what constitutes acceptable usage.
For acceptable usage detail that best faith efforts are fine and that every use doesn't have to be approved but we reserve the right to retroactively disallow usage in cases that we don't think meet the fair usage policy. Express permission can be sought etc etc.

Make sure to credit Jason for his work on creating the logo(s) and mascot.

New Site: Sync meeting

As part of contribute, we should detail the sync meeting. Where you can get the audio, the weekly agenda email (that usually gets sent) etc.

Last Week in Pony - April 30, 2017

for collecting issues for Last Week in Pony to be released on April 30, 2017

New site: Code of Conduct has two h1's

Which is just...

wrong

Either we need a new intro h1 (the basic message from the community page?)

and the existing h1's become h2's and existing h2's become h3's

or something else needs to be done

Last Week in Pony - May 21, 2017

For collecting items for last week in pony for may 21

Add "releases" category to blog

So folks can go there to see a list of all releases and click through to the corresponding entry

Last Week in Pony, June 25, 2017

Last Week in Pony - May 28, 2017

New site: add top level nav

should have community, blog and other "orthogonal" content that gets added later.

probably also has links to the 4 main IA categories

New Website Design/Organization

The website needs a new design with a consistent branding, use of font etc.

As part of this, it needs a strategy for organizing information.

I'm think that we have a top navigation bar that is present on all pages operates in "normal" fashion that most programming websites have. I mention this only so that the design can take this into account. I don't think it is the most important thing we need at the moment.

I'm most interested in getting in place and initial home page that takes into account that the 4 primary types of visitors we have and guiding each to their own section of the site where we can collect together information that would most interest them and give them a "guided tour" experience.

The four primary areas:

"Discover"

Discover would be information for people who have just heard about Pony and are coming to get more information to find out at a high level what Pony is. Our key goal here should be able to get these people interested in Pony and wanting to start learning Pony. The assumption here is that, at this time, "discover" is targeting people who have a technical background and some level of programming experience. We can't however assume that they know what the actor model is, capabilities, high performance etc. We can use those terms as long as we define them.

Once "Pony for X" content is further along, we might want to link to it from here.

"Learn"

Learn collects together the various learning resources that we have and helps guide people through learning Pony. "Start here, then do this". It should contain overviews of the various materials we have. Tutorial, Pony Patterns, "Planet Pony" etc etc. Also link to standard library and what not.

"Reference"

Target audience is returning Pony users who already know the language and are looking for links to various things, news on the latest items and what not. Releases etc etc

"Contributor"

Section of the site with content for people who are interested in contributing to Pony. This could be code, infrastructure, design, or what not.

---

So the main site, when you hit the home page, has some "normal" top nav

a short "what is pony"

followed by some time of text, diagram or something that leads people off to one of the 4 main sections of the site.

---

I'm sure as we add more content we will find content that fits none of the above areas and we will have to address as we find.

Additionally some content will be applicable across multiple areas and will be included in each.

Add profiling to "Existing user?" section

Once someone starts using Pony, a fairly common question is "how do I profile my code?"

broken link in sandbox help/readme

At the end:

How you can install the Pony compiler and tools on your local machine is
explained here.

...should be http://tutorial.ponylang.org/getting-started/installation.html

New Site: research

Research == pony papers

Where do we link to research from?

Discover seems to be a requirement for that.
Learn would make sense as well.

Any other sections?

I don't think this is deserving of its own section.

Last Week in Pony - May 7, 2017

for collecting items for the May 7th Last Week in Pony

New site: Content to organize

• User mailing list
• Developer mailing list
• Tutorial
• Pony for X
• Pony Patterns
• Pony VUG
• Pony VUG mailing list
• State of the stable
• RFCs

There's more content as well, but this is a start. Let's determine where this goes in new IA and put there, then update here to remove.

Last Week in Pony - June 11, 2017

Replace material-docs theme

By now, we've customized most of the material docs theme. We should copy/paste any remaining differences into overrides and then turn our completely overridden site into a theme in theme directory and remove the overrides.

With the amount of overriding that we now do, it can be confusing to figure out which template controls what as a textual search will turn up the template and the override.

Add Netlify to site

They provide free hosting for open source projects and we are moving to Netlify. We should give them a shout out somewhere.

New site: Team page

Humanize the people behind Pony.

Get info on core team members and committers.

Name, picture (some agreed upon standard size), short bio

Link to team page off of community.

Last Week in Pony - April 17, 2017

This issue is to track submissions for Last Week in Pony for April 17, 2017

Add jFrog to site

They are kindly providing us with a free artifactory account.

New site: Add VUG page

Add a more detailed page about the VUG.

what it is, where to see the calendar, where the mailing list is, where the list of videos are, how to give a talk

explain zoom and how to attend

etc

Have standard library documentation on the site

It would be helpful if the standard library documentation could be read somewhere on the site.

New site: Add "basics" to homepage

Homepage as it stands for new site doesn't include any "basics".

These would be placeholders while we work on rest of content to direct people to GitHub, tutorial, standard library docs and the mailing list

New Site: FAQ

Add FAQs

We could have FAQs by section or a single page.

Ideally, we use partials to include only section appropriate FAQs but add a link to a page that combines them all together.

New site: Planet Pony

incorporate Planet Pony content from groups.io wiki into the new website.

https://pony.groups.io/g/user/wiki/Planet-Pony

New Site: Add recent talks and articles

This content exists on the current site. Needs to be slotted into new IA.

New Site: Add state of the stable to community

Content on what it is etc etc

Here is the 2016 entry:

https://pony.groups.io/g/pony/wiki/State-of-the-Stable-2016

Last Week in Pony - June 4, 2017

Last Week in Pony - April 25, 2017

For collecting items related to LWIP for April 25.

New site: detail different levels of supported

Unclear in the IA where this would go but the core team recently agreed to this.
We think its very important for transparency.

---

"supported platforms"

We say FreeBSD is but we don't test on it. We say ARM is, but we don't test on it. We say many Linux are but we don't test on them.

Going forward, we are going to clearly distinguish between different levels of support.

-- Fully supported

We run this on CI and don't expect bugs to sneak through. This is a combo of OS/Distro, compiler and llvm version. Pony team will aim fix all reproduce-able bugs if possible.

-- Partial support

We expect that things should work for this but it isn't fully covered under "Fully supported". We don't expect bugs but its possible due to a general lack of coverage. Pony team will probably need support from reporting user in order to address any bugs if the bug isn't present on "fully supported" platforms

-- It should work

We expect that bugs will be introduced and found by members of the community. Examples here are FreeBSD and anything running on ARM. Pony team will need support from the reporting user to address any bugs if the bug isn't present on a "fully supported" platform.

New site: Roadmap

People always ask

general content..

primary goal: stability, rock solid, drive to version 1.0
secondary goal: supporting infrastructure

projects underway:

distributed pony (arrival unknown)
simple value dependent types (luke's work that is currently being integrated)

Add debugging to "existing user?" section

Once someone starts using Pony, a fairly common question is "how do I debug my code?"

Should include a basic overview of how to interact with Pony code from lldb.

Last Week in Pony - June 18, 2017

Add groups.io to the site

They are providing us with premium level account for mailing list and developer sync meeting audio file hosting for free.

New site: Update blog posts' taxonomy

Last Week in Pony - May 14, 2017

Collect items for the May 14, Last Week in Pony here.

Last Week in Pony, July 2, 2017

New Site: Community

Determine where community goes in new site.

Is it its own section so we have 4?

Discover, Learn, Reference, Contribute, Community

If not its own section, which does it fall in?

New Site: Post new site rollout tasks

A slowly growing list of things we will need to do (only add to this list once the related content is in the new site but before it is deployed)

• Update pony+dev wiki content to point to the website
• Update all COC links to point to COC on website
• Update all COCs from various groups.io locations to point at the website
• Make sure Planet Pony on website is up-to-date with groups.io wiki
• Update Planet Pony on groups.io wiki to point to website
• Update State of the Stable 2016 on groups.io wiki to point to entry in website blog

Known COC links:

• groups.io subgroup/group descriptions
• IRC message of the day
• welcome emails from mailing lists
• github repos