Add instructions to mentors on how to add ideas #61

dpshelio · 2017-02-04T11:23:43Z

It also excludes the readme and template from being rendered by Jekyll

@eteq @taldcroft @Cadair - let me know if this readme looks ok

It also excludes the readme and template from being rendered by jekyll

Cadair · 2017-02-04T13:50:48Z

I would maybe put a TLDR quick start at the top of the readme for the more experienced folks that just need a quick intro. Maybe a list of steps like "make dir, copy template, PR".

dpshelio · 2017-02-04T11:50:20Z

_projects/README.md

+
+Please, if you have any issue with the following steps contact your org admin or
+ask in the multi-client real-time
+[chat platform we have](http://openastronomy.org/contact.html) (Thanks @Cadair!).


We need to create this page with the info @Cadair sent on the mailing list. This page is also needed for the application

professionalism, student interaction, etc...

eteq

@Cadair @dpshelio - OK, left some comments. Note that while reading this I also left some comments about the template that I think are confusing people (and thereby preventing e.g. me from submitting project ideas). Would be good to have @Cadair look and see if any of those will mess up the neat and fancy web site machinery.

One other thing: maybe the _projects/README.md file should actually be /IDEAS.md? It's really not at all obvious that I should look in _projects to find this, because the leading underscore makes it seem like it's a data directory or something rather than a place to actually look for content.

eteq · 2017-02-04T21:37:56Z

_projects/README.md

+the [template file](./_template.md) according to your idea, save it under
+`_projects/YYYY/sub-org/` with a meaningful filename and do a Pull-request.
+
+## What to I need to have an idea?


to->do?

thanks, done.

eteq · 2017-02-04T21:39:09Z

_projects/README.md

+All you need now is to put it in a plain text file following
+the [template file](./_template.md) (you may click in raw to see how it looks).
+
+The file is composed in two parts (separated by a `---`), the top is like a yaml


"like a"? I'm not sure what you mean by that. I'm also not sure it's that important for a mentor to know that? Maybe just drop the part after the first comma in this sentence?

the top uses yaml formatting, the rest markdown. But sure, now it's simpler.

eteq · 2017-02-04T21:39:36Z

_projects/README.md

+part (_e.g._, the top level starts with a 4 level title: `####`).
+
+
+## How do I do so it appears online?


How->What

eteq · 2017-02-04T21:40:32Z

_projects/README.md

+## How do I do so it appears online?
+
+Are you familiar with git/github? If you are not contact us and share the above
+file with us, we will take care to put it in place.


Say who "us" is - give a specific email address or something like that. Remember that if someone doesn't find the information necessary to submit in idea in this document, they probably won't submit anything... Ridiculously low barrier to entry is the goal!

email added.

eteq · 2017-02-04T21:42:19Z

_projects/README.md

+Are you familiar with git/github? If you are not contact us and share the above
+file with us, we will take care to put it in place.
+If, in the other hand, you are feel confident with github: go ahead, fork this
+repository, create a subdirectory for your sub-organisation (if that doesn't


I think this needs to be very specific. For example, "find the subdirectory for your sub-organisation and the year of the project (for example, if you are submitting an astropy project, go to /_projects/2017/astropy). If your organization does not exist, create it following the form of one of the other organizations."

Changed, thanks!

eteq · 2017-02-04T21:44:49Z

_projects/_template.md

+issues:
+ - https://github.com/astropy/astropy/issue/4444
+ - https://github.com/astropy/astropy/issue/5555
+mentors:


This should be "possible mentors"? We never know until the project starts, of course.

But that should be the point of contact at the moment for the student writing the application.

eteq · 2017-02-04T21:45:18Z

_projects/_template.md

+desc: This is the first idea for astropy
+# add a description of your project
+requirements:
+ - The proposal has to contain a clear concept.


I don't understand what this section means. Requirements for the student? Like "knows some astronomy"? Or requirements for the project?

For the student - Changed accordingly.

eteq · 2017-02-04T21:45:57Z

_projects/_template.md

@@ -0,0 +1,50 @@
+---
+name: Example Astropy
+desc: This is the first idea for astropy


What's the difference between this, and the "description" below? I suggest removing this and having the name be the only "description" in this section

This is a one line description - it appears on the box together with the title. Added a description in the comment.

eteq · 2017-02-04T21:46:36Z

_projects/_template.md

+initiatives:
+ - GSOC
+ - SOCIS
+tags:


What does this mean? I think without structure people will be confused by what they're supposed to do with it. I suggest leaving it off.

I've added a description,

eteq · 2017-02-04T21:47:13Z

_projects/_template.md

+tags:
+ - python
+collaborating_projects:
+ - astropy


Again, why is this here? Isn't the file going to already be in the astropy section?

Not the directory structure is just to keep the things in order. This is to be able to separate them by sub-orgs and enables cross-collaborative project.

eteq · 2017-02-04T21:56:01Z

Oh, and I didn't note it in the comments above, but I suggest there be just one template rather than one per project directory. But in the project directory maybe we can place a README that points back to this file?

dpshelio · 2017-02-05T10:28:54Z

Oh, and I didn't note it in the comments above, but I suggest there be just one template rather than one per project directory. But in the project directory maybe we can place a README that points back to this file?

The "templates" on the projects are just so they appear on the website, so you can have an idea of how they look. They will be removed once we get a single real idea. Adding random files in different directories need to then be added to the exclude list in the config file.

One other thing: maybe the _projects/README.md file should actually be /IDEAS.md? It's really not at all obvious that I should look in _projects to find this, because the leading underscore makes it seem like it's a data directory or something rather than a place to actually look for content.

The leading underscore is a jekyll thing (if I'm not wrong). We can move the _projects/README.md above, but I'm just worried that the top directory gets too full and this page is not only for GSOC.

….io into help_ideas

Cadair · 2017-02-08T15:53:26Z

further refinements can happen in subsequent PRs

Add instructions to mentors on how to add ideas

99c8321

It also excludes the readme and template from being rendered by jekyll

dpshelio commented Feb 4, 2017

View reviewed changes

dpshelio and others added 2 commits February 4, 2017 19:39

Update contact page and student guide

01bfa55

shit->stuff

5ba29b6

professionalism, student interaction, etc...

eteq requested changes Feb 4, 2017

View reviewed changes

Simplify text and make more explicit sections - @eteq comments

d6aa901

Merge branch 'help_ideas' of github.com:dpshelio/openastronomy.github…

1c38e3a

….io into help_ideas

dpshelio mentioned this pull request Feb 5, 2017

Update student guide #62

Open

Cadair merged commit c6fc17b into OpenAstronomy:master Feb 8, 2017

dpshelio deleted the help_ideas branch February 11, 2017 18:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add instructions to mentors on how to add ideas #61

Add instructions to mentors on how to add ideas #61

dpshelio commented Feb 4, 2017

Cadair commented Feb 4, 2017

dpshelio Feb 4, 2017

eteq left a comment •

edited

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq Feb 4, 2017

dpshelio Feb 5, 2017

eteq commented Feb 4, 2017 •

edited

dpshelio commented Feb 5, 2017

Cadair commented Feb 8, 2017

		part (_e.g._, the top level starts with a 4 level title: `####`).


		## How do I do so it appears online?

Add instructions to mentors on how to add ideas #61

Add instructions to mentors on how to add ideas #61

Conversation

dpshelio commented Feb 4, 2017

Cadair commented Feb 4, 2017

Choose a reason for hiding this comment

eteq left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eteq commented Feb 4, 2017 • edited

dpshelio commented Feb 5, 2017

Cadair commented Feb 8, 2017

eteq left a comment •

edited

eteq commented Feb 4, 2017 •

edited