Re: [maven-site] branch master updated: Update for grammar and to reflect current practice (#118)

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Re: [maven-site] branch master updated: Update for grammar and to reflect current practice (#118)

rfscholte
Hi,

the site master is broken since this commit, not sure if it is cause, so please investigate:
https://builds.apache.org/job/dist-tool-plugin/site/dist-tool-master-jobs.html

https://builds.apache.org/job/maven-box/job/maven-site/job/master/

thanks,
Robert
On 6-1-2020 21:16:05, [hidden email] <[hidden email]> wrote:
This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site.git


The following commit(s) were added to refs/heads/master by this push:
new b8221dc Update for grammar and to reflect current practice (#118)
b8221dc is described below

commit b8221dc4638d738c332e72cda5d6a595bc87e98b
Author: Elliotte Rusty Harold
AuthorDate: Mon Jan 6 15:15:48 2020 -0500

Update for grammar and to reflect current practice (#118)

* Update for grammar and to reflect current practice
---
content/apt/developers/conventions/jira.apt | 70 +++++++++++++----------------
1 file changed, 32 insertions(+), 38 deletions(-)

diff --git a/content/apt/developers/conventions/jira.apt b/content/apt/developers/conventions/jira.apt
index 11a0b2b..558a78c 100644
--- a/content/apt/developers/conventions/jira.apt
+++ b/content/apt/developers/conventions/jira.apt
@@ -1,10 +1,10 @@
- ------
- Maven JIRA Convention
- ------
- Vincent Siveton
- ------
- 2008-07-05
- ------
+------
+Maven JIRA Conventions
+------
+Vincent Siveton
+------
+2008-07-05
+------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -28,69 +28,63 @@

Maven JIRA Convention

- This document describes how Maven developers should use JIRA, our issue management system.
+This document describes how Maven developers should use JIRA, our issue management system.

* When To Create a JIRA Issue?

- This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).
+This section discusses when to create a JIRA issue versus just committing a change in Git (eventually through a PR).

- * >, like code reformatting, documentation fixes, etc. that aren't going to impact other users can
- be committed without much issue.
+* > such as code reformatting, documentation fixes, etc. that aren't going to impact other users
+can be committed without a JIRA issue.

- * >, like bug fixes, API changes, significant refactoring, new classes, and pretty much any change
- of more than 100 lines, should have a JIRA ticket associated with it, or at least an email discussion.\
- Creating a JIRA issue and referring it in commit comment will ease tracking what changes happen in a release,
- using JIRA automatic release notes creation.
+* > such as bug fixes, API changes, significant refactoring, new classes, and pretty much any change
+of more than 100 lines, should have JIRA tickets.
+Creating a JIRA issue and referring it in the commit comments simplifies tracking the changes that happen in a release,
+using JIRA automatic release notes creation.

- []
+[]

* How To Use Issue Details?

- This section presents some conventions about the issue fields.
+This section presents some conventions about the issue fields.

** Priority

- Committers has the responsibility to realign priority by editing the issue.
+Committers have the responsibility to realign priority by editing the issue.

- >: having a correct release note.
+>: having a correct release note.

** Assignee

- Committers could assign an issue to a specific committer if he thinks it is the right committer.
+Committers can assign an issue to a specific committer that person seems to
+be well placed to address it.

** Component/s

- Committers has the responsibility to specify the correct the component by editing the issue.
+Committers have the responsibility to specify the correct component by editing the issue.

- >: having a correct release note.
+>: having a correct release note.

** Affects Version/s

- By default, the Maven team considers that an issue, which affects a given version, affects also precedent versions, i.e. issue
- which affects Maven 2.0.9 will affect also 2.0, 2.0.1 ... 2.0.9.
- If it is a regression, the committers should specify the affected versions.
+By default, the Maven team considers that an issue which affects a given version also affects preceding versions. For example, an issue
+that affects Maven 2.0.9 also affects 2.0, 2.0.1 ... 2.0.9.
+If it is a regression, the committers should specify the affected versions.

- >: having a correct release note.
+>: having a correct release note.

** Fix Version/s

- TO BE DISCUSSED
-
-~~ Since the Maven team works on the trunk (2.1) and the main branch (2.0.x), the committers should always mark issues that are both 2.0.x and 2.1.
-~~ Reasoning: it's good housekeeping to always say both to keep track of the changes in both branches.
-
** Time Tracking

- The Maven team never uses it. Committers could do it, but like said, it will never be used.
+The Maven team doesn't use this. Committers can if it helps them.

* Further Links

- * {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA Documentation}}
-
- * {{{https://www.atlassian.com/software/jira/docs/latest/issues.html}What is an Issue?}}
+* {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA Documentation}}

- * {{{https://www.atlassian.com/software/jira/docs/latest/projects.html}What is a project?}}
+* {{{https://www.atlassian.com/software/jira/docs/latest/issues.html}What is an Issue?}}

- * {{{https://markmail.org/message/wfv2lw66i2gggnaq}how we handle JIRA versions Thread}}
+* {{{https://www.atlassian.com/software/jira/docs/latest/projects.html}What is a project?}}

- []
+[]

Reply | Threaded
Open this post in threaded view
|

Re: [maven-site] branch master updated: Update for grammar and to reflect current practice (#118)

Sylwester Lachiewicz
hi, the problem is fixed and all the tasks are now green.
BR
Sylwester

wt., 7 sty 2020 o 23:03 Robert Scholte <[hidden email]> napisał(a):

> Hi,
>
> the site master is broken since this commit, not sure if it is cause, so
> please investigate:
>
> https://builds.apache.org/job/dist-tool-plugin/site/dist-tool-master-jobs.html
>
> https://builds.apache.org/job/maven-box/job/maven-site/job/master/
>
> thanks,
> Robert
> On 6-1-2020 21:16:05, [hidden email] <[hidden email]> wrote:
> This is an automated email from the ASF dual-hosted git repository.
>
> elharo pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/maven-site.git
>
>
> The following commit(s) were added to refs/heads/master by this push:
> new b8221dc Update for grammar and to reflect current practice (#118)
> b8221dc is described below
>
> commit b8221dc4638d738c332e72cda5d6a595bc87e98b
> Author: Elliotte Rusty Harold
> AuthorDate: Mon Jan 6 15:15:48 2020 -0500
>
> Update for grammar and to reflect current practice (#118)
>
> * Update for grammar and to reflect current practice
> ---
> content/apt/developers/conventions/jira.apt | 70
> +++++++++++++----------------
> 1 file changed, 32 insertions(+), 38 deletions(-)
>
> diff --git a/content/apt/developers/conventions/jira.apt
> b/content/apt/developers/conventions/jira.apt
> index 11a0b2b..558a78c 100644
> --- a/content/apt/developers/conventions/jira.apt
> +++ b/content/apt/developers/conventions/jira.apt
> @@ -1,10 +1,10 @@
> - ------
> - Maven JIRA Convention
> - ------
> - Vincent Siveton
> - ------
> - 2008-07-05
> - ------
> +------
> +Maven JIRA Conventions
> +------
> +Vincent Siveton
> +------
> +2008-07-05
> +------
>
> ~~ Licensed to the Apache Software Foundation (ASF) under one
> ~~ or more contributor license agreements. See the NOTICE file
> @@ -28,69 +28,63 @@
>
> Maven JIRA Convention
>
> - This document describes how Maven developers should use JIRA, our issue
> management system.
> +This document describes how Maven developers should use JIRA, our issue
> management system.
>
> * When To Create a JIRA Issue?
>
> - This section discusses when to create a JIRA issue versus just
> committing a change in Git (eventually through a PR).
> +This section discusses when to create a JIRA issue versus just committing
> a change in Git (eventually through a PR).
>
> - * >, like code reformatting, documentation fixes, etc. that aren't going
> to impact other users can
> - be committed without much issue.
> +* > such as code reformatting, documentation fixes, etc. that aren't
> going to impact other users
> +can be committed without a JIRA issue.
>
> - * >, like bug fixes, API changes, significant refactoring, new classes,
> and pretty much any change
> - of more than 100 lines, should have a JIRA ticket associated with it, or
> at least an email discussion.\
> - Creating a JIRA issue and referring it in commit comment will ease
> tracking what changes happen in a release,
> - using JIRA automatic release notes creation.
> +* > such as bug fixes, API changes, significant refactoring, new classes,
> and pretty much any change
> +of more than 100 lines, should have JIRA tickets.
> +Creating a JIRA issue and referring it in the commit comments simplifies
> tracking the changes that happen in a release,
> +using JIRA automatic release notes creation.
>
> - []
> +[]
>
> * How To Use Issue Details?
>
> - This section presents some conventions about the issue fields.
> +This section presents some conventions about the issue fields.
>
> ** Priority
>
> - Committers has the responsibility to realign priority by editing the
> issue.
> +Committers have the responsibility to realign priority by editing the
> issue.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Assignee
>
> - Committers could assign an issue to a specific committer if he thinks it
> is the right committer.
> +Committers can assign an issue to a specific committer that person seems
> to
> +be well placed to address it.
>
> ** Component/s
>
> - Committers has the responsibility to specify the correct the component
> by editing the issue.
> +Committers have the responsibility to specify the correct component by
> editing the issue.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Affects Version/s
>
> - By default, the Maven team considers that an issue, which affects a
> given version, affects also precedent versions, i.e. issue
> - which affects Maven 2.0.9 will affect also 2.0, 2.0.1 ... 2.0.9.
> - If it is a regression, the committers should specify the affected
> versions.
> +By default, the Maven team considers that an issue which affects a given
> version also affects preceding versions. For example, an issue
> +that affects Maven 2.0.9 also affects 2.0, 2.0.1 ... 2.0.9.
> +If it is a regression, the committers should specify the affected
> versions.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Fix Version/s
>
> - TO BE DISCUSSED
> -
> -~~ Since the Maven team works on the trunk (2.1) and the main branch
> (2.0.x), the committers should always mark issues that are both 2.0.x and
> 2.1.
> -~~ Reasoning: it's good housekeeping to always say both to keep track of
> the changes in both branches.
> -
> ** Time Tracking
>
> - The Maven team never uses it. Committers could do it, but like said, it
> will never be used.
> +The Maven team doesn't use this. Committers can if it helps them.
>
> * Further Links
>
> - * {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA
> Documentation}}
> -
> - * {{{
> https://www.atlassian.com/software/jira/docs/latest/issues.html}What is
> an Issue?}}
> +* {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA
> Documentation}}
>
> - * {{{
> https://www.atlassian.com/software/jira/docs/latest/projects.html}What is
> a project?}}
> +* {{{https://www.atlassian.com/software/jira/docs/latest/issues.html}What
> is an Issue?}}
>
> - * {{{https://markmail.org/message/wfv2lw66i2gggnaq}how we handle JIRA
> versions Thread}}
> +* {{{
> https://www.atlassian.com/software/jira/docs/latest/projects.html}What is
> a project?}}
>
> - []
> +[]
>
>
Reply | Threaded
Open this post in threaded view
|

Re: [maven-site] branch master updated: Update for grammar and to reflect current practice (#118)

rfscholte
Thanks for fixing and porting to markdown

Robert

On 8-1-2020 01:16:57, Sylwester Lachiewicz <[hidden email]> wrote:
hi, the problem is fixed and all the tasks are now green.
BR
Sylwester

wt., 7 sty 2020 o 23:03 Robert Scholte napisał(a):

> Hi,
>
> the site master is broken since this commit, not sure if it is cause, so
> please investigate:
>
> https://builds.apache.org/job/dist-tool-plugin/site/dist-tool-master-jobs.html
>
> https://builds.apache.org/job/maven-box/job/maven-site/job/master/
>
> thanks,
> Robert
> On 6-1-2020 21:16:05, [hidden email] wrote:
> This is an automated email from the ASF dual-hosted git repository.
>
> elharo pushed a commit to branch master
> in repository https://gitbox.apache.org/repos/asf/maven-site.git
>
>
> The following commit(s) were added to refs/heads/master by this push:
> new b8221dc Update for grammar and to reflect current practice (#118)
> b8221dc is described below
>
> commit b8221dc4638d738c332e72cda5d6a595bc87e98b
> Author: Elliotte Rusty Harold
> AuthorDate: Mon Jan 6 15:15:48 2020 -0500
>
> Update for grammar and to reflect current practice (#118)
>
> * Update for grammar and to reflect current practice
> ---
> content/apt/developers/conventions/jira.apt | 70
> +++++++++++++----------------
> 1 file changed, 32 insertions(+), 38 deletions(-)
>
> diff --git a/content/apt/developers/conventions/jira.apt
> b/content/apt/developers/conventions/jira.apt
> index 11a0b2b..558a78c 100644
> --- a/content/apt/developers/conventions/jira.apt
> +++ b/content/apt/developers/conventions/jira.apt
> @@ -1,10 +1,10 @@
> - ------
> - Maven JIRA Convention
> - ------
> - Vincent Siveton
> - ------
> - 2008-07-05
> - ------
> +------
> +Maven JIRA Conventions
> +------
> +Vincent Siveton
> +------
> +2008-07-05
> +------
>
> ~~ Licensed to the Apache Software Foundation (ASF) under one
> ~~ or more contributor license agreements. See the NOTICE file
> @@ -28,69 +28,63 @@
>
> Maven JIRA Convention
>
> - This document describes how Maven developers should use JIRA, our issue
> management system.
> +This document describes how Maven developers should use JIRA, our issue
> management system.
>
> * When To Create a JIRA Issue?
>
> - This section discusses when to create a JIRA issue versus just
> committing a change in Git (eventually through a PR).
> +This section discusses when to create a JIRA issue versus just committing
> a change in Git (eventually through a PR).
>
> - * >, like code reformatting, documentation fixes, etc. that aren't going
> to impact other users can
> - be committed without much issue.
> +* > such as code reformatting, documentation fixes, etc. that aren't
> going to impact other users
> +can be committed without a JIRA issue.
>
> - * >, like bug fixes, API changes, significant refactoring, new classes,
> and pretty much any change
> - of more than 100 lines, should have a JIRA ticket associated with it, or
> at least an email discussion.\
> - Creating a JIRA issue and referring it in commit comment will ease
> tracking what changes happen in a release,
> - using JIRA automatic release notes creation.
> +* > such as bug fixes, API changes, significant refactoring, new classes,
> and pretty much any change
> +of more than 100 lines, should have JIRA tickets.
> +Creating a JIRA issue and referring it in the commit comments simplifies
> tracking the changes that happen in a release,
> +using JIRA automatic release notes creation.
>
> - []
> +[]
>
> * How To Use Issue Details?
>
> - This section presents some conventions about the issue fields.
> +This section presents some conventions about the issue fields.
>
> ** Priority
>
> - Committers has the responsibility to realign priority by editing the
> issue.
> +Committers have the responsibility to realign priority by editing the
> issue.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Assignee
>
> - Committers could assign an issue to a specific committer if he thinks it
> is the right committer.
> +Committers can assign an issue to a specific committer that person seems
> to
> +be well placed to address it.
>
> ** Component/s
>
> - Committers has the responsibility to specify the correct the component
> by editing the issue.
> +Committers have the responsibility to specify the correct component by
> editing the issue.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Affects Version/s
>
> - By default, the Maven team considers that an issue, which affects a
> given version, affects also precedent versions, i.e. issue
> - which affects Maven 2.0.9 will affect also 2.0, 2.0.1 ... 2.0.9.
> - If it is a regression, the committers should specify the affected
> versions.
> +By default, the Maven team considers that an issue which affects a given
> version also affects preceding versions. For example, an issue
> +that affects Maven 2.0.9 also affects 2.0, 2.0.1 ... 2.0.9.
> +If it is a regression, the committers should specify the affected
> versions.
>
> - >: having a correct release note.
> +>: having a correct release note.
>
> ** Fix Version/s
>
> - TO BE DISCUSSED
> -
> -~~ Since the Maven team works on the trunk (2.1) and the main branch
> (2.0.x), the committers should always mark issues that are both 2.0.x and
> 2.1.
> -~~ Reasoning: it's good housekeeping to always say both to keep track of
> the changes in both branches.
> -
> ** Time Tracking
>
> - The Maven team never uses it. Committers could do it, but like said, it
> will never be used.
> +The Maven team doesn't use this. Committers can if it helps them.
>
> * Further Links
>
> - * {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA
> Documentation}}
> -
> - * {{{
> https://www.atlassian.com/software/jira/docs/latest/issues.html}What is
> an Issue?}}
> +* {{{https://www.atlassian.com/software/jira/docs/latest/}JIRA
> Documentation}}
>
> - * {{{
> https://www.atlassian.com/software/jira/docs/latest/projects.html}What is
> a project?}}
> +* {{{https://www.atlassian.com/software/jira/docs/latest/issues.html}What
> is an Issue?}}
>
> - * {{{https://markmail.org/message/wfv2lw66i2gggnaq}how we handle JIRA
> versions Thread}}
> +* {{{
> https://www.atlassian.com/software/jira/docs/latest/projects.html}What is
> a project?}}
>
> - []
> +[]
>
>