Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [che-dev] Release documentation


On 19 Mar 2018, at 5:55, Roman Iuvshyn wrote:

hello, is this plan still actual? I do not see any actions related to this
discussion.


Yes, this is in fact should be in effect but I think it is not used.

I think at this point we need to tweak this process a bit. I suggest that @Eugene @Roman opens a Release Notes issue for every release that is assigned to all the teams and holds the release until all the teams confirm that they are done with the release notes on the issue. Similar to the process that JBoss tools follows [1]. I think
those issues may even be scripted.

Committers, if you are merging a new and noteworthy feature please take time to document it on Release notes and ping Eugene for it. For Red Hatters, the content that you create for sprint demos is probably good to be
used as part of the release notes.

[1] https://issues.jboss.org/browse/JBIDE-25839



On Thu, Dec 7, 2017 at 11:26 PM, Gennady Azarenkov <gazarenk@xxxxxxxxxx>
wrote:



On Thu, Dec 7, 2017 at 10:49 PM, Brad Micklea <bmicklea@xxxxxxxxxx> wrote:

Step 4 is done before the PR is merged, right?


It is important to have it done before Release, there will be more than
one PRs to RelNotes document.
I.e. Step 3 will be repeated (sorry if not clear)



On Thu, Dec 7, 2017 at 12:15 PM, Gennady Azarenkov <gazarenk@xxxxxxxxxx>
wrote:

That's makes sense, Release notes should be meaningful.
Let's move Che6 on master branch and restart normal release process.

I support Gorkem's proposal in general just small refinements (related
to process details) from my side:

0/ Create /release-notes folder in che-docs repository
1/ After release M.N Release Notes Maintainer (RNM) creates file called
M.N+1.md
2/ After merging *New & Noteworthy* changes Contributor have to offer another PR with changes to this file describing changes the best way he/she
can
3/ RNM (mandatory) and other Contributors (optionally) review and merge
this PR
4/ In parallel, before M.N+1 release RNM and PM edit this document,
making it correct, nice and marketing friendly.
5/ Publish M.N+1.md Release Notes
Actors:
Contributors - Che project committers
RNM - Eugene (backup Gennady)
PM - Stevan (backup Brad)

Thanks,
Gennady



On Wed, Dec 6, 2017 at 11:59 PM, Gorkem Ercan <gorkem.ercan@xxxxxxxxx>
wrote:

As you may have noticed we have not been doing a great job with our
release marketing lately.
This is due to the fact that people who used to do that have either
changed priorities or got additional responsibilities.
Therefore, the committers/contributors to the project needs to get more
involved with release documentation.

I would like to propose the following changes.
1. Instead of compiling the release notes on medium, we compile them on
the docs repository as md files. And publish them on the website.
2. Instead of our current plain release notes, I would like to do a combination of *New & Noteworthy* and release notes. Similar to what
Eclipse IDE or VS Code does.
3. The above means the committers must provide the material needed for the noteworthy features to the docs repo as PRs. This should not be
hard for Red Hatters as you would be demoing those anyways.
4. It is a known fact that developers do their documentation, but just in case I propose we can add updates to release doc as a criteria for PR
merges.
5. Steven becomes the editor for the document and publishes guidelines
for screenshots, animated gifs etc.
6. We upload a youtube video of team leads rapping all the new features
:)

Thanks,
Gorkem

_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev



_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev




--

Brad Micklea // Product Management // Developer Tools // 416.707.0792
<(416)%20707-0792>

_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev



_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe
from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev




--

ROMAN IUVSHYN

Red Hat

<https://www.redhat.com/>

riuvshyn@xxxxxxxxxx
<https://red.ht/sig>


_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev


Back to the top