adding showcase_documentation.md to contributor docs

[connieliu0]

(edit 6/12/20 for more clarity)
Context: This PR is being opened because when I first started my GSoC project of modifying the showcase I had no idea how to add information and how the structure was set up. After contacting Ashley, the original creator of the showcase, and learning how to set up the showcase, me and my mentors thought it would be a good idea to add documentation! This is based off of a combination of her own directions and mine.
Changes: This pull request will add a Markdown file with steps as to how to add to the showcase and some images that go along with that tutorial.
Concerns: My biggest concern is making sure this is readable and makes sense!
@yining1023 @joeyklee

[joeyklee]

@connieliu0 - Please see discussion here for ways of documenting your issues -- https://github.com/processing/p5.js-website/issues/795#issuecomment-643256504. Note that many of the same guidelines apply to opening Pull Requests.

An example of a detailed PR

see: ml5js/ml5-library#831

In the PR discussion linked above, you can see that the author outlines some crucial aspects such as:

1. Context -- refers to why this PR is being opened and what discussions led to this. Includes links to any open issues.
2. Changes -- a summary of the changes made in this PR. Ideally you can explain in human language what changes you've created. While maintainers can go and see what code you've changed, explaining it in normal language is helpful for setting expectations.
3. Any questions or concerns -- list any questions, comments, or concerns that you may have for the maintainers to address
4. Any notes of building or setup that make your PR happen.
5. Tag anyone involved in this PR discussion. e.g. @yining1023

If you can please add these notes to your PR description and ensure that anyone that might be interested in or impacted by this PR is tagged. Thanks!

[joeyklee]

@connieliu0 - Would you be able to move your documentation images into the /contributor_docs/assets directory (https://github.com/processing/p5.js-website/tree/master/contributor_docs/assets) ?

You can either:

Option 1:

You can keep the subdirectory showcase_documentation_images so that the path looks like:

https://github.com/processing/p5.js-website/tree/master/contributor_docs/assets/showcase_documentation_images

Or Option 2:

Namespace all of your images such that they are prefixed with showcase__<name of your image>

My feeling would be that it is better to keep all your images and assets in one place.

Make sure to update the path in your showcase documentation markdown file after doing so.

[yining1023]

Maybe the link for "how to copy the GitHub repository" needs to be updated?

[yining1023]

Good job on adding this contributor doc! This will be very helpful for people when updating the showcase page. Thank you, @connieliu0!

I left some minor comments inline.

I think the base branch of this repo changed from master to main to some links here are broken at the moment. It can be fixed by replacing /tree/master/ with /tree/main/.

[connieliu0]

When merging please ignore the changes I made to main.css

[lmccart]

@connieliu0 github doesn't easily enable us to ignore a file that's checked in. i think the easiest fix would be to undo the changes you've made to main.css (looks like there's not too many) and push one more commit to this branch.
you can see those changes here

[connieliu0]

@lmccart just updated!

[lmccart]

looks like this is nearly there, just needs one conflict resolution in the main.css file. @connieliu0 do you know how to resolve this? let us know if you need help.

[connieliu0]

@lmccart just updated and resolved the conflict! Just a side note that the documentation is probably set to change by the end of the summer as a heads up to look out for another PR about that

[lmccart]

@yining1023 @joeyklee please feel free to merge if this look good to you!

[connieliu0]

As an update to this PR -> we are planning to migrate the structure of the showcase to a React site as seen here (https://github.com/processing/p5.js-website/issues/819), I will update the md for this and note that it is for Showcase 1.0, but I was wondering if it's still worth to merge this PR if the showcase is no longer being maintained through the HBS structure

[joeyklee]

Looks good from my side. Well done!

[joeyklee]

@connieliu0 - Given that you've migrated the showcase over to https://github.com/processing/p5.js-website/issues/819 we could consider doing the following:

1. We can merge in this PR so these additions are available in the p5.js-website repo.
2. If the core p5 maintainers are ok with it, when your site in https://github.com/processing/p5.js-website/issues/819 is live and linked as a subdomain of the p5js.org, we can add a deprecation notice to these docs pointing them to your new site and CONTRIBUTING document in the other repo.

In any case, I think it makes sense to have at least a link from the p5js-website repo out to your other repo mentioned in https://github.com/processing/p5.js-website/issues/819

[connieliu0]

@joeyklee Option 2 sounds good! I imagine then this PR would get merged after the 2020 website is live and running then right? And then the link in the showcase document under p5.js would have a link to connieliu0/p5.js-showcase repo then?

[limzykenneth]

If the wish is for the showcase to be an officially maintained part of the website, we can maybe consider moving the repo to the "processing" organization on github (ie. processing/p5.js-showcase).

[lmccart]

@connieliu0 as I've mentioned before, I have big concerns about trying to maintain an additional website, the current one is beyond capacity as it is. I think this might be better though of as a standalone special exhibition site, similar to http://contributors-zine.p5js.org/. this would mean we'd host it at showcase.p5js.org as mentioned in #819, but processing would not host or maintain the repository itself. however, we're in the midst of a leadership transition, so I would invite @mcturner1995 to weigh in here.

[connieliu0]

@lmccart The plan of having me maintain the showcase repo until it gets transferred to next year's GSoC participant (if showcase is a GSoC project next year) sounds good to me!
Also do you know the process of making the site into showcase.p5js.org? How would that work?

[mcturner1995]

Hi everyone!
My name is Moira (Mo) Turner and I'm the income p5.js lead. I'm still getting familiar with how things run but I agree with @lmccart that hosting two websites is beyond our capacity right now but I am in support of the project to be hosted at showcase.p5js.org and maintained by @connieliu0 and following GSoC participants. I am not familiar with the process to relocate the site to showcase.p5js.org but will discuss with @lmccart to get that info to you @connieliu0

[connieliu0]

@mcturner1995 @lmccart sounds good! I'm hoping to release everything the first week of September, so I'm hoping to change the domain name before then.

[mcturner1995]

@connieliu0 we can set up the showcase on a exhibition site off of p5 using DNS but we need your IPv4 address of where your site is located. You can email the number at [email protected]

[limzykenneth]

@mcturner1995 @connieliu0 If the page is still going to be hosted on github pages at https://github.com/connieliu0/p5.js-showcase, the custom domain option in the repo can be set to showcase.p5js.org then the DNS record can add a CNAME for showcase pointing to connieliu0.github.io. More info here

[connieliu0]

ohh @limzykenneth would that require me to set the CNAME or would @mcturner1995 need to do it first? Once the cname is set, I can change the custom domain option on github right?

[limzykenneth]

No specific order required, just the two things needs to be setup then it should work.

[mcturner1995]

Great! I'll look into it!

[mcturner1995]

@connieliu0 we set the CNAME on our end and have it pointing to connieliu0.github.io as @limzykenneth suggested. Let me know if you all need anymore support on our side to get things up and running.