You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@gora.apache.org by wa...@apache.org on 2021/06/13 23:09:48 UTC
[gora-site] branch main updated: Gora Ready
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/gora-site.git
The following commit(s) were added to refs/heads/main by this push:
new e1d31c5 Gora Ready
e1d31c5 is described below
commit e1d31c5c27bd6cfa66d38e6ac661b6abd0ca829e
Author: Dave Fisher <da...@davefisher.tech>
AuthorDate: Sun Jun 13 16:08:10 2021 -0700
Gora Ready
---
LICENSE | 202 ++++++++++++++++++++++++++++++++++++++++++++++
README.md | 6 +-
migration/README.md | 31 +++++++
migration/changes.txt | 55 +++++++++++++
theme/plugins/asfgenid.py | 60 +++++++++-----
5 files changed, 334 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..124568a
--- /dev/null
+++ b/migration/README.md
@@ -0,0 +1,31 @@
+# CMS Migration
+
+1. Markdown conversions
+
+ - All files must have a title
+ - Changed some a tags in markdown to markdown syntax
+ - A couple of typos
+
+ 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': True # uses [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..b27210e
--- /dev/null
+++ b/migration/changes.txt
@@ -0,0 +1,55 @@
+==== ./content/nightly_builds.md
+==== ./content/version_control.md
+==== ./content/credits.md
+==== ./content/contribute.md
+==== ./content/related.md
+==== ./content/current/gora-sql.md
+==== ./content/current/gora-mongodb.md
+==== ./content/current/gora-couchdb.md
+==== ./content/current/overview.md
+==== ./content/current/gora-shims.md
+==== ./content/current/gora-metamodel.md
+==== ./content/current/compiler-cli.md
+==== ./content/current/gora-kudu.md
+==== ./content/current/gora-hbase.md
+==== ./content/current/quickstart.md
+==== ./content/current/gora-aerospike.md
+==== ./content/current/gora-ignite.md
+==== ./content/current/gora-pig.md
+==== ./content/current/gora-cassandra.md
+==== ./content/current/gora-camel.md
+==== ./content/current/gora-jcache.md
+==== ./content/current/compiler.md
+==== ./content/current/tutorial.md
+321c321
+< ## Basic API </title>
+---
+> ## Basic API
+==== ./content/current/index.md
+74c74
+< ### GoraCI Integration Testsing Suite
+---
+> ### GoraCI Integration Testing Suite
+==== ./content/current/api/javadoc.md
+==== ./content/current/gora-accumulo.md
+==== ./content/current/gora-conf.md
+==== ./content/current/gora-solr.md
+==== ./content/current/gora-core.md
+==== ./content/current/gora-dynamodb.md
+==== ./content/roadmap.md
+0a1,2
+> Title: Gora Roadmap Documentation
+>
+==== ./content/index.md
+16c16
+< Apache Spark™, Apache Flink™ and Apache Pig™ support. Gora uses the [Apache Software License v2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
+---
+> Apache Spark™, Apache Flink™ and Apache Pig™ support. Gora uses the <a href="https://www.apache.org/licenses/LICENSE-2.0.html">Apache Software License v2.0</a>.
+18c18
+< You can find the Gora DOAP [here](./current/doap_Gora.rdf).
+---
+> You can find the Gora DOAP <a href="./current/doap_Gora.rdf">here</a>.
+==== ./content/mailing_lists.md
+==== ./content/downloads.md
+==== ./content/about.md
+==== ./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()