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

Survey existing successful open source projects for best practices in web-page content and appearance #1647

Open
smiths opened this issue Jun 27, 2019 · 10 comments
Labels
needs-action-items A clear 'path to resolution' is needed to close any ticket.

Comments

@smiths
Copy link
Collaborator

smiths commented Jun 27, 2019

@danscime, please look at existing open source projects to identify the kind of information we should include on our web-page and how best to present it. Two good examples to look at are:

  1. https://grass.osgeo.org/
  2. https://mooseframework.org/

@Mornix was also planning on sending you another example. You should also feel free to find your own samples, or to consult with your colleagues for additional examples.

@smiths
Copy link
Collaborator Author

smiths commented Jun 28, 2019

@danscime, I think one of the patterns you will see in successful open source projects from academia is a list of publications and presentations. I'm going to attach the current list of presentations related to Drasil. It would be great if we could get these on our web-page at some point. We should also incorporate links to the presentations slides and papers where feasible. Many of the slides are available in the Drasil repo in the Presentations folder. Some others can be found on-line. I can help you with this when we get to putting up this material.

Dissemination.pdf

@danscime
Copy link
Collaborator

Suggested by @Mornix https://llvm.org/

@danscime
Copy link
Collaborator

danscime commented Jul 2, 2019

@smiths For a section that lists publications and presentations, should I list them in a format similar to the Dissemination.pdf you sent? Or should I list links? Or both together?

@smiths
Copy link
Collaborator Author

smiths commented Jul 10, 2019

@danscime, I think you should use the last option - list the publications in full reference form, and include links.

@smiths
Copy link
Collaborator Author

smiths commented Jul 25, 2019

@danscime, you should look at the guidelines here (found by @JacquesCarette) and see how our web-page stacks up to "best practices":

https://github.com/kylelobo/The-Documentation-Compendium

Has anything tangible come out of this exercise yet? Is there a list somewhere of the kinds of information and structure that others use on their web-pages?

@danscime
Copy link
Collaborator

Have not done too much of this yet, but will go through and create a list of features and notes from each site.

@smiths
Copy link
Collaborator Author

smiths commented Jul 25, 2019

Sounds good!

@danscime
Copy link
Collaborator

Begun via a15ba74

@danscime
Copy link
Collaborator

@smiths
Copy link
Collaborator Author

smiths commented Jul 25, 2019

This is a good start @danscime. In a later pass it would be nice to see where the different projects overlap; that is, what things do they all have. In the end, I'll be interested in your recommendations on what we should add to our web-page. 😄

@danscime danscime removed their assignment Aug 29, 2019
@JacquesCarette JacquesCarette mentioned this issue May 14, 2020
2 tasks
@balacij balacij added the needs-action-items A clear 'path to resolution' is needed to close any ticket. label Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-action-items A clear 'path to resolution' is needed to close any ticket.
Projects
None yet
Development

No branches or pull requests

3 participants