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 7a94a8b Refactor the README into the Developer Guide
new 5bace76 Merge pull request #22 from jbampton/format-html
7a94a8b is described below
commit 7a94a8be4e8b998efd96a3b23c1fc701c1e94cfa
Author: John Bampton <[email protected]>
AuthorDate: Wed Mar 17 07:53:36 2021 +1000
Refactor the README into the Developer Guide
Add HTML `title` tag and indent HTML
---
DEVELOPER.md | 49 ++++++++++++++++++++++++++++++++++++++++
README.md | 19 +---------------
theme/apache/templates/base.html | 10 ++++----
3 files changed, 55 insertions(+), 23 deletions(-)
diff --git a/DEVELOPER.md b/DEVELOPER.md
new file mode 100644
index 0000000..cd8e10e
--- /dev/null
+++ b/DEVELOPER.md
@@ -0,0 +1,49 @@
+# Developer Guide
+
+We are using [GitHub Flavored Markdown](https://github.github.com/gfm/).
+
+JavaScript frameworks available are:
+
+- [JQuery 3.3.1 Slim](https://code.jquery.com/jquery-3.3.1.slim.js)
+- [Popper
1.14.7](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.js)
+- [Bootstrap
4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.js)
+
+CSS frameworks available are:
+
+- [Bootstrap
4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.css)
+- [GitHub Markdown
3.0.1](https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/3.0.1/github-markdown.css)
+
+Additional testing with GitHub Actions:
+
+- [Lint](.github/workflows/lint.yml) -- [GitHub
Actions](https://docs.github.com/en/actions) Workflow
+- [Flake8](https://flake8.pycqa.org/en/latest/) -
[Python](https://www.python.org/) based tool for style guide enforcement
+- [markdownlint](https://github.com/DavidAnson/markdownlint) -- using
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) -
[Node.js](https://nodejs.org/) style checker and lint tool for
[Markdown](https://daringfireball.net/projects/markdown/) and CommonMark files
+- [misspell](https://github.com/client9/misspell) --
[Golang](https://golang.org/) library to correct commonly misspelled English
words quickly
+- [yamllint](https://yamllint.readthedocs.io/en/stable/) -- a linter for
[YAML](https://yaml.org/) files
+
+For misspell you can pass in `-w` to autocorrect misspelled words. You can
also autocorrect some markdownlint
+errors by using the `--fix` flag.
+
+Developer Tools:
+
+- [EditorConfig](https://editorconfig.org/) -- helps maintain consistent
coding styles for multiple developers working on the same project across
various editors and IDEs
+- [GNU Midnight Commander](http://midnight-commander.org/) -- is a free
cross-platform orthodox file manager. It was started by Miguel de Icaza in 1994
as a clone of the then-popular Norton Commander. GNU Midnight Commander is part
of the GNU project and is licensed under the terms of the GNU General Public
License
+
+IDEs that some contributors to Petri use:
+
+- [Atom](https://atom.io/) -- At GitHub, we’re building the text editor we’ve
always wanted: hackable to the core, but approachable on the first day without
ever touching a config file. We can’t wait to see what you build with it
+- [GNU Emacs](https://www.gnu.org/software/emacs/) -- An extensible,
customizable, free/libre text editor — and more. At its core is an interpreter
for Emacs Lisp, a dialect of the Lisp programming language with extensions to
support text editing
+- [GNU nano](https://www.nano-editor.org/) -- a text editor for Unix-like
computing systems or operating environments using a command line interface. It
emulates the Pico text editor, part of the Pine email client, and also provides
additional functionality. Unlike Pico, nano is licensed under the GNU General
Public License. Released as free software by Chris Allegretta in 1999, nano
became part of the GNU Project in 2001
+- [IntelliJ IDEA Community](https://www.jetbrains.com/idea/) -- Every aspect
of IntelliJ IDEA has been designed to maximize developer productivity.
Together, intelligent coding assistance and ergonomic design make development
not only productive but also enjoyable
+- [Sublime Text](https://www.sublimetext.com/) -- Sublime Text is a
sophisticated text editor for code, markup and prose. You'll love the slick
user interface, extraordinary features and amazing performance
+- [Vim](https://www.vim.org/) -- a highly configurable text editor built to
make creating and changing any kind of text very efficient. It is included as
"vi" with most UNIX systems and with Apple macOS
+
+Useful Git tools:
+
+- [GitHub Desktop](https://desktop.github.com/) -- Simple collaboration from
your desktop
+- [GitKraken](https://www.gitkraken.com/) -- Free Git GUI for Windows, Mac,
Linux
+- [Git GUI Clients](https://git-scm.com/downloads/guis)
+- [gitk](https://git-scm.com/docs/gitk) -- The Git repository browser
+- [git-gui](https://git-scm.com/docs/git-gui) -- A portable graphical
interface to Git
+- [gitg](https://gitlab.gnome.org/GNOME/gitg) -- a graphical user interface
for git
+- [GitHub CLI](https://cli.github.com/) -- Take GitHub to the command line.
GitHub CLI brings GitHub to your terminal. Free and open source
diff --git a/README.md b/README.md
index a050649..5ebda7a 100644
--- a/README.md
+++ b/README.md
@@ -18,21 +18,4 @@ CI/CD is via a [.asf.yaml
file](https://cwiki.apache.org/confluence/display/INFR
- [Pelican Configuration](pelicanconf.py) -- pelican configuration
- [ASF YAML build](.asf.yaml) -- ASF infrastructure instructions
-JavaScript frameworks available are:
-
-- [JQuery 3.3.1 Slim](https://code.jquery.com/jquery-3.3.1.slim.js)
-- [Popper
1.14.7](https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.js)
-- [Bootstrap
4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.js)
-
-CSS frameworks available are:
-
-- [Bootstrap
4.3.1](https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.css)
-- [GitHub Markdown
3.0.1](https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/3.0.1/github-markdown.css)
-
-Additional testing with GitHub Actions:
-
-- [Lint](.github/workflows/lint.yml) -- [GitHub
Actions](https://docs.github.com/en/actions) Workflow
-- [Flake8](https://flake8.pycqa.org/en/latest/) -
[Python](https://www.python.org/) based tool for style guide enforcement
-- [markdownlint](https://github.com/DavidAnson/markdownlint) -- using
[markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) -
[Node.js](https://nodejs.org/) style checker and lint tool for
Markdown/CommonMark files
-- [misspell](https://github.com/client9/misspell) --
[Golang](https://golang.org/) library to correct commonly misspelled English
words quickly
-- [yamllint](https://yamllint.readthedocs.io/en/stable/) -- a linter for
[YAML](https://yaml.org/) files
+Check out [Developer Guide](DEVELOPER.md) to get started contributing.
diff --git a/theme/apache/templates/base.html b/theme/apache/templates/base.html
index 0370802..44c3f4b 100644
--- a/theme/apache/templates/base.html
+++ b/theme/apache/templates/base.html
@@ -21,6 +21,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,
initial-scale=1, shrink-to-fit=no">
+ <title>Apache Petri</title>
<link rel="shortcut icon"
href="https://www.apache.org/favicons/favicon.ico";>
<link rel="stylesheet"
@@ -28,8 +29,7 @@
integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
crossorigin="anonymous">
<link rel="stylesheet"
-
href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/3.0.1/github-markdown.min.css";
- >
+
href="https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/3.0.1/github-markdown.min.css";>
<link rel="stylesheet" href="theme/css/apache.css">
{% endblock %}
@@ -96,12 +96,12 @@
<div class="row container-fluid">
<div class="col-sm">
<a href="https://www.apache.org/";>
- <img src="https://www.apache.org/img/asf_logo.png"; alt="The
Apache Software Foundation" border="0" style="margin-top: 2px" width="200"/>
+ <img src="https://www.apache.org/img/asf_logo.png"; alt="The
Apache Software Foundation" border="0" style="margin-top: 2px" width="200"/>
</a>
</div>
<div class="col-sm center-align">
<a href="https://www.apache.org/foundation/contributing.html";>
- <img
src="https://www.apache.org/images/SupportApache-small.png"; style="margin-left:
92px" height="64" width="64"/>
+ <img src="https://www.apache.org/images/SupportApache-small.png";
style="margin-left: 92px" height="64" width="64"/>
</a>
</div>
<div class="col-sm right-align">
@@ -121,7 +121,7 @@
</div>
</footer>
-
+
<script src="https://www.apachecon.com/event-images/snippet.js";></script>
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js";
integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo"
![https://www.apache.org/img/asf_logo.png"](https://www.apache.org/img/asf_logo.png"){kind=link}
![https://www.apache.org/images/SupportApache-small.png"](https://www.apache.org/images/SupportApache-small.png"){kind=link}