You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@river.apache.org by wa...@apache.org on 2021/06/13 22:47:26 UTC
[river-site] branch main updated (db51a15 -> ccdf6e4)
This is an automated email from the ASF dual-hosted git repository.
wave pushed a change to branch main
in repository https://gitbox.apache.org/repos/asf/river-site.git.
from db51a15 update asfgenid plugin
new a901b5c River Ready
new ccdf6e4 fix docco
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
LICENSE | 202 +++++++++++
README.md | 6 +-
migration/README.md | 38 ++
migration/changes.txt | 862 ++++++++++++++++++++++++++++++++++++++++++++++
theme/plugins/asfgenid.py | 60 +++-
5 files changed, 1148 insertions(+), 20 deletions(-)
create mode 100644 LICENSE
create mode 100644 migration/README.md
create mode 100644 migration/changes.txt
[river-site] 02/02: fix docco
Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/river-site.git
commit ccdf6e496aac05c0732625d3f2a508fd64416fc9
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Sun Jun 13 15:46:00 2021 -0700
fix docco
---
migration/README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/migration/README.md b/migration/README.md
index c52c310..be5a841 100644
--- a/migration/README.md
+++ b/migration/README.md
@@ -33,6 +33,6 @@
- 'headings': True # Fix up headings w/ permalinks
- 'headings_re': r'^h[1-4]'
- 'permalinks': True,
- - 'toc': False # does not use [TOC]
+ - 'toc': True # uses [TOC]
- 'toc_headers': r"h[1-4]",
- 'tables': True # Fix up for markdown table class
[river-site] 01/02: River Ready
Posted by wa...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/river-site.git
commit a901b5c973ea7170d8391640cb5eec4eeb1b56b4
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Sun Jun 13 15:26:17 2021 -0700
River Ready
---
LICENSE | 202 +++++++++++
README.md | 6 +-
migration/README.md | 38 ++
migration/changes.txt | 862 ++++++++++++++++++++++++++++++++++++++++++++++
theme/plugins/asfgenid.py | 60 +++-
5 files changed, 1148 insertions(+), 20 deletions(-)
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
index b520d60..4e93e58 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,5 @@
-# Bootstrap
\ No newline at end of file
+# Pelican ASF Website
+
+See [ASF-Pelican](https://infra.apache.org/asf-pelican.html)
+
+See [migration notes](migration/README.md)
diff --git a/migration/README.md b/migration/README.md
new file mode 100644
index 0000000..c52c310
--- /dev/null
+++ b/migration/README.md
@@ -0,0 +1,38 @@
+# CMS Migration
+
+1. Markdown conversions
+
+ - Rename from mdtext to md
+ - All files must have a title
+ - Metadata is a single line
+ - Tables must not have spaces in `|---|---|`
+ - Added space to separate html from markdown
+ - Four spaces signal a code block adjust when it is a list
+ - Use https hyperlinks
+ - No bare ### headings
+ - No spaces in http request parameters
+ - Use` __` for emphasis around a `*`
+
+ See [changes.txt](changes.txt)
+
+2. Theme Template
+
+ CMS templates were converted into `base.html`
+
+3. Configuration
+
+ See [pelicanconf.py](../pelicanconf.py)
+
+4. Pelican ASF plugin configuration
+
+ [asfgenid.py](../theme/plugins/asfgenid.py)
+
+ - 'unsafe_tags': True # allow style, script, and iframe tags
+ - 'metadata': False # no metadata replacement in markdown files
+ - 'elements': False # CMS didn't use mdx_elementid featuresz
+ - 'headings': True # Fix up headings w/ permalinks
+ - 'headings_re': r'^h[1-4]'
+ - 'permalinks': True,
+ - 'toc': False # does not use [TOC]
+ - 'toc_headers': r"h[1-4]",
+ - 'tables': True # Fix up for markdown table class
diff --git a/migration/changes.txt b/migration/changes.txt
new file mode 100644
index 0000000..43a2614
--- /dev/null
+++ b/migration/changes.txt
@@ -0,0 +1,862 @@
+==== ./content/wot.md
+==== ./content/dev-doc/building-a-release.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+25a11
+>
+31a18
+>
+37a25
+>
+44a33
+>
+58a48
+>
+69a60
+>
+75a67
+>
+81a74
+>
+87a81
+>
+93a88
+>
+107a103
+>
+117a114
+>
+125a123
+>
+132a131
+>
+==== ./content/dev-doc/building-river.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+22a8
+>
+33a20
+>
+50a38
+>
+55a44
+>
+67a57
+>
+68a59
+>
+69a61
+>
+81a74
+>
+82a76
+>
+92a87
+>
+97a93
+>
+104a101
+>
+124a122
+>
+128a127
+>
+140a140
+>
+148a149
+>
+152a154
+>
+173a176
+>
+178a182
+>
+==== ./content/dev-doc/development-process.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+22a8
+>
+29a16
+>
+41a29
+>
+55a44
+>
+65a55
+>
+215a206
+>
+229a221
+>
+273a266
+>
+276a270
+>
+280a275
+>
+285a281
+>
+292a289
+>
+==== ./content/dev-doc/roadmap.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/dev-doc/source-code.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+23c8
+< River uses [Subversion](http://subversion.tigris.org/) to manage its source code. Instructions on Subversion use can be found [here](http://svnbook.red-bean.com).
+---
+> River uses [Subversion](https://subversion.apache.org/) to manage its source code. Instructions on Subversion use can be found [here](http://svnbook.red-bean.com).
+27c12,13
+< ####
+---
+>
+>
+39a26
+>
+41d27
+< ####
+49a36
+>
+51d37
+< ####
+69a56
+>
+71d57
+< ####
+82a69
+>
+84d70
+< ####
+==== ./content/dev-doc/ci.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+29c14
+< - | -
+---
+> --|--
+38a24
+>
+44a31
+>
+52a40
+>
+==== ./content/user-doc/specification.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/supported-platforms.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+22,23d6
+< ####
+<
+26c9
+< -- | ----
+---
+> ---|-----
+33,34d15
+< ####
+<
+38c19
+< ------- | -----
+---
+> --------|------
+57c38
+< ------ | -------
+---
+> -------|-------
+==== ./content/user-doc/get-involved.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+23a9
+>
+39d24
+<
+43c28
+< specification into a set of language a d transport agnostic architectural
+---
+> specification into a set of language and transport agnostic architectural
+52d36
+<
+56d39
+<
+60a44
+>
+66d49
+< * The [River wiki](http://wiki.apache.org/river/) is open for anyone to contribute related documentation.
+==== ./content/user-doc/resources.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/releases.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+27a13
+>
+41a28
+>
+56a44
+>
+59a48
+>
+70a60
+>
+79a70
+>
+88a80
+>
+97a90
+>
+115a109
+>
+==== ./content/user-doc/success-stories.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+22a8
+>
+23a10
+>
+66a54
+>
+72a61
+>
+77a67
+>
+78a69
+>
+114,115c105,106
+< To visualize and manage the entire system, we built [an application on
+< the Netbeans platform](http://netbeans.dzone.com/nb-financial-management-console)
+---
+> To visualize and manage the entire system, we built an application on
+> the Netbeans platform
+131a123
+>
+146a139
+>
+166a160
+>
+185a180
+>
+187,188c182
+< - [Original Jini.org success stories](http://www.jini.org/wiki/Who_uses_Jini%3F), including:
+< 1. [TNO ICT, The Netherlands](http://www.tno.nl/informatie-_en_communicatietechnologie/)
+---
+> - Original Jini.org success stories, including:
+191,192c185
+< - [JavaWorld](http://www.javaworld.com/javaworld/jw-10-2001/jw-1005-jiniinterview.html) interview with Dr. Ted Achacoso from GroupServe
+< - [Jan Newmarch's Guide to Jini Technologies](http://jan.newmarch.name/java/jini/tutorial/Overview.html#Success Stories) contains a section on Jini successes
+---
+> - [Jan Newmarch's Guide to Jini Technologies](http://jan.newmarch.name/java/jini/tutorial/Overview.html#Success%20Stories) contains a section on Jini successes
+==== ./content/user-doc/networking.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/people.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+27,31c12,16
+< | ***** |Roy T. Fielding|Adobe *(chair pro-tem)*|
+< | ***** |Dennis Reedy|Asarian Technologies LLC|
+< | ***** |Dan Rollo||
+< | ***** |Patricia Shanahan||
+< | ***** |Bryan Thompson||
+---
+> | __*__ |Roy T. Fielding|Adobe *(chair pro-tem)*|
+> | __*__ |Dennis Reedy|Asarian Technologies LLC|
+> | __*__ |Dan Rollo||
+> | __*__ |Patricia Shanahan||
+> | __*__ |Bryan Thompson||
+==== ./content/user-doc/readings.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+25,26c10,11
+< - <a href="https://blogs.oracle.com/hinkmond/entry/easy_iot_sensor_on_boarding" data-toggle="tooltip" title="Making Internet of Things (IoT) Smarter with Java Technology and Deep Learning AI">Hinkmond Wong's Weblog</a>
+< - <a href"http://www.eclipse.org/californium data-toggle="tooltip" title="The Californium (Cf) core provides the central framework with the protocol implementation to build your Internet of Things applications.">Californium</a>
+---
+> - <a href="https://blogs.oracle.com/hinkmond/entry/easy_iot_sensor_on_boarding" data-toggle="tooltip" title="Making Internet of Things (IoT) Smarter with Java Technology and Deep Learning AI">Hinkmond Wong's Weblog</a>
+> - <a href="http://www.eclipse.org/californium" data-toggle="tooltip" title="The Californium (Cf) core provides the central framework with the protocol implementation to build your Internet of Things applications.">Californium</a>
+==== ./content/user-doc/glossary.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/mailing-lists.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+22a8
+>
+==== ./content/user-doc/website.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/helloworld.md
+1,17c1,2
+< Title:
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> Title: Hello World
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/maven-artifacts.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/getting-started.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+35d19
+< ####
+43a28
+>
+45d29
+< </div>
+46a31
+> </div>
+51d35
+< ####
+76a61
+>
+79,82d63
+<
+<
+<
+< ####
+97a79
+>
+99a82
+>
+106a90
+>
+109,112d92
+<
+<
+<
+< ####
+125a106
+>
+127a109
+>
+179a162
+>
+182,184d164
+<
+<
+< ####
+195a176
+>
+197a179
+>
+231a214
+>
+234,236d216
+<
+<
+< ####
+245a226
+>
+247a229
+>
+254a237
+>
+==== ./content/user-doc/found-a-bug.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/user-doc/cookbook.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/discussion-jarpackaging.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/README.md
+==== ./content/index.md
+1,16c1,2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> title: Home Page
+> license: https://www.apache.org/licenses/LICENSE-2.0
+24d9
+<
+31d15
+<
+49,50d32
+<
+<
+61d42
+<
+==== ./content/generics-javaspaces.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/discussion-futuredirection.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./content/discussion-internet.md
+2,17c2
+< Notice: Licensed to the Apache Software Foundation (ASF) under one
+< or more contributor license agreements. See the NOTICE file
+< distributed with this work for additional information
+< regarding copyright ownership. The ASF licenses this file
+< to you under the Apache License, Version 2.0 (the
+< "License"); you may not use this file except in compliance
+< with the License. You may obtain a copy of the License at
+< .
+< http://www.apache.org/licenses/LICENSE-2.0
+< .
+< Unless required by applicable law or agreed to in writing,
+< software distributed under the License is distributed on an
+< "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+< KIND, either express or implied. See the License for the
+< specific language governing permissions and limitations
+< under the License.
+---
+> license: https://www.apache.org/licenses/LICENSE-2.0
+==== ./README.md
diff --git a/theme/plugins/asfgenid.py b/theme/plugins/asfgenid.py
index eddcb19..1a663f8 100644
--- a/theme/plugins/asfgenid.py
+++ b/theme/plugins/asfgenid.py
@@ -26,26 +26,26 @@ Which is BSD licensed, but is very much rewritten.
'''
ASF_GENID = {
- 'unsafe_tags': 'True', # fix script, style, and iframe html that gfm filters as unsafe
- 'metadata': True, # {{ metadata }} inclusion of data in the html.
- 'elements': True, # {#id} and {.class} annotations.
- 'headings': True, # add slugified id to headings missing id. Can be overridden by page metadata.
- 'headings_re': r'^h[1-6]', # regex for which headings to check.
- 'permalinks': True, # add permalinks to elements and headings when id is added.
- 'toc': True, # check for [TOC] and add Table of Content if present.
- 'toc_headers': r'h[1-6]', # regex for which headings to include in the [TOC]
- 'tables': True, # add class="table" for tables missing class.
+ 'unsafe_tags': True, # fix script, style, and iframe html that gfm filters as unsafe
+ 'metadata': True, # {{ metadata }} inclusion of data in the html.
+ 'elements': True, # {#id} and {.class} annotations.
+ 'headings': True, # add slugified id to headings missing id. Can be overridden by page metadata.
+ 'headings_re': r'^h[1-6]', # regex for which headings to check.
+ 'permalinks': True, # add permalinks to elements and headings when id is added.
+ 'toc': True, # check for [TOC] and add Table of Content if present.
+ 'toc_headers': r'h[1-6]', # regex for which headings to include in the [TOC]
+ 'tables': True, # add class="table" for tables missing class.
'debug': False
}
# Fixup tuples for HTML that GFM makes into text.
FIXUP_UNSAFE = [
- (re.compile(r'<script'),'<script'),
- (re.compile(r'</script'),'</script'),
- (re.compile(r'<style'),'<style'),
- (re.compile(r'</style'),'</style'),
- (re.compile(r'<iframe'),'<iframe'),
- (re.compile(r'</iframe'),'</iframe')
+ (re.compile(r'<script'), '<script'),
+ (re.compile(r'</script'), '</script'),
+ (re.compile(r'<style'), '<style'),
+ (re.compile(r'</style'), '</style'),
+ (re.compile(r'<iframe'), '<iframe'),
+ (re.compile(r'</iframe'), '</iframe')
]
# Find {{ metadata }} inclusions
@@ -68,6 +68,7 @@ PARA_MAP = {
# Find table tags - to check for ones without class attribute.
TABLE_RE = re.compile(r'^table')
+
# An item in a Table of Contents - from toc.py
class HtmlTreeNode(object):
def __init__(self, parent, header, level, id):
@@ -263,7 +264,7 @@ def generate_toc(content, tags, title, toc_headers):
# convert the HtmlTreeNode into Beautiful Soup
tree_string = '{}'.format(tree)
tree_soup = BeautifulSoup(tree_string, 'html.parser')
- # Make the ToC availble to the theme's template
+ # Make the ToC available to the theme's template
content.toc = tree_soup.decode(formatter='html')
# replace the first [TOC] with the generated table of contents
for tag in tags:
@@ -272,6 +273,22 @@ def generate_toc(content, tags, title, toc_headers):
tree_soup = ''
+# create breadcrumb html
+def make_breadcrumbs(rel_source_path, title):
+ parts = rel_source_path.split('/')
+ url = '/'
+ crumbs = []
+ crumbs.append(f'<a href="/">Home</a> » ')
+ # don't process the filename part
+ last = len(parts)-1
+ for i in range(last):
+ url = f"{url}{parts[i]}/"
+ p = parts[i].capitalize()
+ crumbs.append(f'<a href="{url}">{p}</a> » ')
+ crumbs.append(f'<a href="#">{title}</a>')
+ return ''.join(crumbs)
+
+
# add the asfdata metadata into GFM content.
def add_data(content):
""" Mix in ASF data as metadata """
@@ -303,7 +320,7 @@ def generate_id(content):
ids = set()
# track permalinks
permalinks = set()
-
+
# step 1 - fixup html that cmark marks unsafe - move to later?
if asf_genid['unsafe_tags']:
fixup_content(content)
@@ -314,9 +331,14 @@ def generate_id(content):
# page title
title = content.metadata.get('title', 'Title')
# assure relative source path is in the metadata
- content.metadata['relative_source_path'] = content.relative_source_path
+ content.metadata['relative_source_path'] = rel_source_path = content.relative_source_path
+ # create breadcrumb html
+ content.metadata['breadcrumbs'] = breadcrumbs = make_breadcrumbs(rel_source_path, title)
# display output path and title
print(f'{content.relative_source_path} - {title}')
+ # if debug display breadcrumb html
+ if asf_genid['debug']:
+ print(f' {breadcrumbs}')
# enhance metadata if done by asfreader
add_data(content)
@@ -373,7 +395,7 @@ def tb_connect(pel_ob):
"""Print any exception, before Pelican chews it into nothingness."""
try:
generate_id(pel_ob)
- except:
+ except Exception:
print('-----', file=sys.stderr)
print('FATAL: %s' % (pel_ob.relative_source_path), file=sys.stderr)
traceback.print_exc()