incubator-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bertrand Delacretaz (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (INCUBATOR-234) Incubator Cookbook
Date Wed, 10 Apr 2019 07:03:00 GMT

    [ https://issues.apache.org/jira/browse/INCUBATOR-234?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16814129#comment-16814129
] 

Bertrand Delacretaz commented on INCUBATOR-234:
-----------------------------------------------

I like these but now we have to decide whether everything belongs in the cookbook, or if we
should rather keep it a the overview / principles level and have the details in the guides.
I think I prefer the latter (though the guides need cleaning up as well): it allows people
to read the cookbook in one sitting and get lots of useful information without too many details.

Or maybe go back to building the cookbook out of multiple smaller files (like before [https://github.com/apache/incubator/commit/20c6621b],
and have two sections, main and appendix, in those files. Display the main sections only in
the cookbook, with a link to the full info including appendix - that might be provide the
most consistent view.

> Incubator Cookbook
> ------------------
>
>                 Key: INCUBATOR-234
>                 URL: https://issues.apache.org/jira/browse/INCUBATOR-234
>             Project: Incubator
>          Issue Type: Task
>          Components: site
>            Reporter: Bertrand Delacretaz
>            Priority: Major
>
> As discussed at [1] the goal is to create a single page Incubator Cookbook, with all
the details of the incubation process, in chronological order of the incubation journey.
> This should be as concise as possible, with links to more information where strictly
needed, and adopt a friendly tone in the sense of clearly making the Incubator a service to
our podlings.
> Draft page at [http://incubator.apache.org/cookbook/ ,  |http://incubator.apache.org/cookbook/]source
[https://github.com/apache/incubator/blob/master/pages/cookbook/index.ad]
> As a next step I'll focus on getting a mostly consistent set of topics and we can then
share the writing work.
>  [1] [https://lists.apache.org/thread.html/51fe5d659778bed5b6385c7c39bbdf688d02f1b1dbe02d595d514cbb@%3Cgeneral.incubator.apache.org%3E]
> h2. How to contribute to this effort
>  * Feedback and suggestions are welcome here.
>  * Pull requests at [https://github.com/apache/incubator] also work
>  * Discussions on the [general@incubator.a.o|mailto:general@incubator.a.o] list, [https://lists.apache.org/list.html?general@incubator.apache.org]



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org


Mime
View raw message