This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/petri-site.git
The following commit(s) were added to refs/heads/master by this push:
new db074c8 Lint Markdown and add information on rules
new 0c9e207 Merge pull request #17 from jbampton/lint-markdown
db074c8 is described below
commit db074c8346ac26f37a4bec554171c3b794f44030
Author: John Bampton <[email protected]>
AuthorDate: Wed Mar 17 03:08:20 2021 +1000
Lint Markdown and add information on rules
---
.markdownlint.yaml | 17 ++++++++++++++---
content/pages/cookbook.md | 10 ++++++++++
content/pages/faq.md | 5 -----
content/pages/index.md | 3 +++
content/pages/mentors.md | 1 +
5 files changed, 28 insertions(+), 8 deletions(-)
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
index 3e45238..06efdbe 100644
--- a/.markdownlint.yaml
+++ b/.markdownlint.yaml
@@ -1,8 +1,19 @@
+# https://github.com/DavidAnson/markdownlint#rules--aliases
+
+# MD001 heading-increment/header-increment - Heading levels should only
increment by one level at a time
+MD001: false
+
+# MD004 ul-style - Unordered list style
MD004: false
-MD012: false
+
+# MD013 line-length - Line length
MD013: false
-MD022: false
-MD032: false
+
+# MD033 no-inline-html - Inline HTML
MD033: false
+
+# MD034 no-bare-urls - Bare URL used
MD034: false
+
+# MD041 first-line-heading/first-line-h1
MD041: false
diff --git a/content/pages/cookbook.md b/content/pages/cookbook.md
index 9daf0b3..788efac 100644
--- a/content/pages/cookbook.md
+++ b/content/pages/cookbook.md
@@ -5,33 +5,41 @@ title: Cookbook @ Apache Petri
During its time in Petri a culture may go through a number of transitions. We
track these on a web page.
### About
+
This section should describe the project.
Whenever a community begins to call itself Apache Foo then it needs to provide
a DISCLAIMER. Contact [email protected] for the text.
### Website
+
Provide the current website for the project community. When the community
wishes Petri will guide in the creation of a website on Apache Infrastructure.
### Mailing Lists
+
List the mailing lists used by the community. Petri will create Apache Mailing
lists when requested.
### Source Code Repository
+
Provide the url to the source code repository. Petri will request an Apache
Git repository when the community is ready to migrate.
This will require an SGA be filed (See below.)
If a different type of repository is required then please discuss with your
Mentors.
### Issue Tracker
+
Provide the address to your issue tracker. The ASF offers both JIRA and GitHub
issue trackers. Bugzilla is also an option for older projects.
### Wiki
+
Provide the address to your project wiki, if any. The ASF offers both
Confluence and GitHub wikis.
Other Wikis would require other support which should be discussed with your
mentors.
### Releases (not Apache)
+
The URL where project releases can be found. The assumption is that releases
will not be Apache releases until late in the process.
Once an Apache Release has been made then the "not" can be struck.
### Licensing Transitions
+
- "No SGA" or "SGA provided". [Software License
Grant](https://www.apache.org/licenses/contributor-agreements.html#grants)
- "No ICLAs" or "ICLAs provided". [Contributor License
Agreements](https://www.apache.org/licenses/contributor-agreements.html#clas)
- "No ASF Headers" or "ASF Headers Applied". [Applying the Apache
License](https://infra.apache.org/apply-license.html)
@@ -39,9 +47,11 @@ Once an Apache Release has been made then the "not" can be
struck.
- "No Apache NOTICE" or "NOTICE approved". Have your mentors review.
### Mentors
+
A list of your current mentors.
### Machine Readable Status
+
The status information for a community should also be updated in
[petri.yaml](https://github.com/apache/petri-site/blob/master/content/info.yaml).
diff --git a/content/pages/faq.md b/content/pages/faq.md
index fc8afea..3b3c0d5 100644
--- a/content/pages/faq.md
+++ b/content/pages/faq.md
@@ -77,7 +77,6 @@ The Board makes the ultimate decision, and generally ensures
that the project ha
[recognize merit](http://incubator.apache.org/guides/community.html); and
* Shown auditable decision making on the provided mailing list.
-
## Is Apache Petri right for you?
If you are:
@@ -98,7 +97,6 @@ accept projects that are not supported by some form of
community.
## What about the Maturity Model? Haven’t other projects bypassed incubation
by meeting these requirements?
-
In March 2015 Apache Zest (now Polygene) became the first project to enter
the ASF as a Top-Level Project — without entering the Apache Incubator.
As
part of the discussion, the project
@@ -131,7 +129,6 @@ No, unless the projects intend to apply for TLP status and
migrate their
source control to ASF hardware. This applies both to Incubator podlings
and direct-to-TLP applicants.
-
## If our project wants to become an official Apache project, what is the best
way to do so?
There is more than one way to do so: not all incoming projects will be
@@ -206,7 +203,6 @@ and Apache Members can subscribe) and introduce yourself!
We don’t
have any forms or questionnaires, but may introduce these should
the need arise.
-
## If a project wants to move out of the Apache Incubator and into Petri, what
happens?
We don’t recommend leaving the Incubator, if the podling is already
@@ -219,4 +215,3 @@ perform any needed changes to make that happen.
#### Markdown Source
- [view
source](https://github.com/apache/petri-site/blob/master/content/pages/faq.md)
-
diff --git a/content/pages/index.md b/content/pages/index.md
index ba833e0..5e6bcb6 100644
--- a/content/pages/index.md
+++ b/content/pages/index.md
@@ -23,6 +23,7 @@ be made to construct a new Apache Project Management
Committee (PMC) for the
external community.
### About "The Apache Way"
+
- [The Apache Way](https://www.apache.org/theapacheway/index.html)
- [Sustainable Open Source](https://s.apache.org/GhnI)
- [How it Works](https://www.apache.org/foundation/how-it-works.html)
@@ -44,10 +45,12 @@ questionnaires, but may introduce these should the need
arise.
Please read our [FAQ](/faq) or ask questions on [email protected]
### Petri Repositories and Issue Tracking
+
- [Website](https://github.com/apache/petri-site)
- [Issues](https://github.com/apache/petri-site/issues)
### Petri Status Files
+
- [info.yaml](https://petri.apache.org/info.yaml)
- [petri.rdf](https://projects.apache.org/project.html?petri)
diff --git a/content/pages/mentors.md b/content/pages/mentors.md
index 029f54c..e3aa30c 100644
--- a/content/pages/mentors.md
+++ b/content/pages/mentors.md
@@ -2,6 +2,7 @@ title: Mentors at Apache Petri
<!-- Licensed under ALv2 -->
## Introduction
+
Mentors at Apache Petri provides insight into the Apache Way and general
oversight of the learning process
for projects within the Apache Petri.
