Added release to downloads, first release page, new rya.css, readme.
Project: http://git-wip-us.apache.org/repos/asf/incubator-rya-site/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-rya-site/commit/5cc07d51 Tree: http://git-wip-us.apache.org/repos/asf/incubator-rya-site/tree/5cc07d51 Diff: http://git-wip-us.apache.org/repos/asf/incubator-rya-site/diff/5cc07d51 Branch: refs/heads/master Commit: 5cc07d512637c1bcc014d24b1f109c8b3f9cfb9c Parents: 74af1da Author: David Lotts <[email protected]> Authored: Thu Jul 20 13:12:56 2017 -0400 Committer: David Lotts <[email protected]> Committed: Thu Aug 3 15:36:10 2017 -0400 ---------------------------------------------------------------------- .gitattributes | 1 + README.md | 103 ++++++++++++++++++++++ content/_config.yml | 3 +- content/_includes/themes/apache/default.html | 1 + content/_includes/themes/apache/footer.html | 2 +- content/_posts/2016-10-28-release-3.2.10.md | 51 +++++++++++ content/assets/themes/apache/css/rya.css | 20 +++++ content/download.md | 60 ++++++------- 8 files changed, 204 insertions(+), 37 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/.gitattributes ---------------------------------------------------------------------- diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md new file mode 100644 index 0000000..65ac46e --- /dev/null +++ b/README.md @@ -0,0 +1,103 @@ +# Apache Rya Web site source + +This project is the markdown version of the official Apache Rya website. +This project is processed by Jekyll and committed to the asf-branch. +- Branch master (you are here) is this source in markdown for the Jekyll tool. +- Branch asf-site is the compiled HTML that is deployed to the webserver. + +## Modification + +To make changes to the website: + +1. Git clone git://git.apache.org/incubator-rya-site.git branch master +2. Created a new branch. + + ``git checkout -b your_new_branch_name_here`` + +3. Modify the markdown as needed using a text editor. +4. New releases go in folder _posts along with other news. +5. Releases must use the prescribed file naming format and have a header variable catagories=release along with some other variables describing the version. +6. The file download.md, using its scripts, should automatically populate the coresponding html based on your new post file and its variables, but it may need tweaking. + +7. Install Jekyll. This may not be straight forward if you don't have a ruby environment. You may have to add Linux distro packages, then ruby gems, then more packages as dependendencies present themselves. + +8. Run this command in the content/ folder to auto-compile and web serve on port 4000: + + ``cd content/`` + + ``bundle exec jekyll serve`` + +9. Now just iteratevly use your editor and web browser to edit and test changes. +10. When you are done making changes: +11. Move the content/target folder out of the way, you will commit this separately. +12. Commit changes, add a remote to your own public git repo, and push to it with --set-upstream. +13. Create a pull request to the repo apache/incubator-rya-site branch master. +14. Now for the deployable HTML that you moved above: +15. In the same git folder, + + ``git checkout --force origin/asf-site + + git checkout -b another_new_branch_name_here + + rm -r content/*`` + +Note: --force removes any stray files left over. + +Note: replace another_new_branch_name_here with a new branch hinting at your changes. + +Note: the recursive remove of all the content is necessary to discover files deleted as well as changed. + +16. Now copy the folder formally named target/ into the project, renaming it to content/. +17. Use git status to observe changes. The css and other template files are probably not changed. If they are flagged as modified, investigate CRLF or other trival differences. See .gitattributes. +18. When done, commit to your repo in a new branch as above. +19. Create a pull request as above, except to be merged into branch asf-site. +20. Beg and bribe peers and mentors to review changes. Consider hosting the site temporarily for review, see below. +21. Make changes and commit them as above. No need to create new pull requests as they follow the latest commit in the branch. + + +## Hosting for review on Github pages + +1. Review the setup here: https://pages.github.com/ using "project-site" +2. It doesn't mention it in the quick start above, but it will also publish a site from a branch named "gh-pages" which is important since master is already used for another purpose. +3. Start with your branch of project "incubator-rya-site" as pushed to your remote, that is based on the asf-site branch. +4. Create and checkout a new branch named "gh-pages". This will not be used in a pull request. + + ``git checkout -b gh-pages`` + +5. Move the contents of the "content" folder to the root of the project. +6. Modify each HTML page prepending to all references (href= and src=) to the site with "/incubator-rya-site" . Ignore references beginning http. + +For example: + + Before: + + ``<link href="/assets/themes/apache/bootstrap/css/bootstrap.css" rel="stylesheet">`` + + After: + + ``<link href="/incubator-rya-site/assets/themes/apache/bootstrap/css/bootstrap.css" rel="stylesheet">`` + + +This command should do the replacement: + + ``find . -name \*.html -exec sed -ri 's/=\"\//=\"\/incubator-rya-site\//g' {} \;`` + + +7. Commit changes and push to your public github project named incubator-rya-site. + + ``git commit -a -m "New stuff"`` + + ``git push git push --set-upstream yourGitHub gh-pages`` + +8. Login to your github account and to the project incubator-rya-site forked from apache/incubator-rya-site, and click on the Settings tab. Scroll down to GitHub Pages and choose source=gh-pages branch. Save. + +9. Browse to the site: + + https://yourGitHubID.github.io/incubator-rya-site + +replacing yourGitHubID with your GitHub account ID. + +10. Check your work and ask others to review by sending this URL. + + + http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/_config.yml ---------------------------------------------------------------------- diff --git a/content/_config.yml b/content/_config.yml index a0e7c75..d9bb023 100644 --- a/content/_config.yml +++ b/content/_config.yml @@ -23,8 +23,9 @@ exclude: [README.md,Gemfile*] keep_files: [".git", ".svn", "apidocs"] # The base path where the website is deployed -baseurl: / +baseurl: / # baseurl: /Users/cs/adina/ryawebsite/target/ +url: http://rya.apache.org # End _config.yml http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/_includes/themes/apache/default.html ---------------------------------------------------------------------- diff --git a/content/_includes/themes/apache/default.html b/content/_includes/themes/apache/default.html index 7c1ca9e..688c380 100644 --- a/content/_includes/themes/apache/default.html +++ b/content/_includes/themes/apache/default.html @@ -18,6 +18,7 @@ <link href="{{ ASSET_PATH }}/bootstrap/css/bootstrap.css" rel="stylesheet"> <link href="{{ ASSET_PATH }}/css/style.css?body=1" rel="stylesheet" type="text/css"> <link href="{{ ASSET_PATH }}/css/syntax.css" rel="stylesheet" type="text/css" media="screen" /> + <link href="{{ ASSET_PATH }}/css/rya.css" rel="stylesheet" type="text/css" media="screen" /> <!-- Le fav and touch icons --> <!-- Update these with your own images <link rel="shortcut icon" href="images/favicon.ico"> http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/_includes/themes/apache/footer.html ---------------------------------------------------------------------- diff --git a/content/_includes/themes/apache/footer.html b/content/_includes/themes/apache/footer.html index 101fe9e..c3b0c7d 100644 --- a/content/_includes/themes/apache/footer.html +++ b/content/_includes/themes/apache/footer.html @@ -18,7 +18,7 @@ </div> {% endif %} <div> - Copyright © 2016 <a href="http://www.apache.org";>The Apache Software Foundation</a>. + Copyright © 2017 <a href="http://www.apache.org";>The Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. <br> http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/_posts/2016-10-28-release-3.2.10.md ---------------------------------------------------------------------- diff --git a/content/_posts/2016-10-28-release-3.2.10.md b/content/_posts/2016-10-28-release-3.2.10.md new file mode 100644 index 0000000..8df92f0 --- /dev/null +++ b/content/_posts/2016-10-28-release-3.2.10.md @@ -0,0 +1,51 @@ +--- +layout: post +date: "2016-10-28" +title: First Release +description: details of the first release of Rya (Incubating) +version: 3.2.10 +fullVersion: rya-incubating-3.2.10 +filename: rya-project-3.2.10-incubating-source-release +releaseNotes: https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12334209&styleName=Html&projectId=12319020 +categories: [release] +tag: v3.2.10 +--- +{% comment %} +Some of the variables above are used on the summary page that iterates through posts where catagories=release. +{% endcomment %}{% capture apacheDistMirror %}http://www.apache.org/dyn/closer.lua/{{ site.data.project.incubator_slash_name }}/{{ page.fullVersion }}{% endcapture %} +{% capture d %}https://dist.apache.org/repos/dist/release/{{ site.data.project.incubator_slash_name }}/{{ page.fullVersion }}{% endcapture %} + + + + + +This is Rya's first release, version {{ page.version }}. It is available as a source code download: + +- [Source download from Apache]({{ apacheDistMirror }}/{{ page.filename }}.zip) +- Verify: {% comment %} +{% endcomment %} [pgp]( {{ d }}/{{ page.filename }}.zip.asc ){% comment %} +{% endcomment %} [md5]( {{ d }}/{{ page.filename }}.zip.md5 ){% comment %} +{% endcomment %} [sha1]({{ d }}/{{ page.filename }}.zip.sha1) +- [Release notes]({{ page.releaseNotes }}) +- [Central repository for Maven and other dependency managers](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.rya%22) + +[Verify](http://www.apache.org/dyn/closer.cgi#verify) +using the corresponding *pgp* signature (using the committer file in +[KEYS](http://www.apache.org/dist/{{ site.data.project.incubator_slash_name }}/KEYS)). +If you cannot do that, the *md5* or *sha1* hash file may be used to check that the +download has completed okay. + +For fast downloads, current source distributions are hosted on mirror servers; +older source distributions are in the +[archive](http://archive.apache.org/dist/incubator/{{ site.data.project.unix_name }}/). +If a download from a mirror fails, retry, and the second download will likely +succeed. + +For security, hash and signature files are always hosted at +[Apache](https://www.apache.org/dist/{{ site.data.project.incubator_slash_name }}). + +Next steps: +- [Building from Source](https://github.com/apache/incubator-rya/blob/{{ page.sha }}/extras/rya.manual/src/site/markdown/build-source.md) +- [Quick Start](https://github.com/apache/incubator-rya/blob/{{ page.sha }}/extras/rya.manual/src/site/markdown/quickstart.md) +- [Typical First Steps](https://github.com/apache/incubator-rya/blob/{{ page.sha }}/extras/rya.manual/src/site/markdown/sm-firststeps.md) +- [Manual -- includes documents above](https://github.com/apache/incubator-rya/blob/{{ page.sha }}/extras/rya.manual/src/site/markdown/index.md) http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/assets/themes/apache/css/rya.css ---------------------------------------------------------------------- diff --git a/content/assets/themes/apache/css/rya.css b/content/assets/themes/apache/css/rya.css new file mode 100644 index 0000000..e5f5633 --- /dev/null +++ b/content/assets/themes/apache/css/rya.css @@ -0,0 +1,20 @@ +/* Rya specific styles */ + +body table { + width : 100% !important; + border : 1px solid gray; +} + +body table tr td { + border : 1px solid gray; + padding : 5px 5px 5px 5px; +} + +body table tr th { + border : 1px solid gray; + padding : 5px 5px 5px 5px; + background-color: #B0C4DE; +} + + + http://git-wip-us.apache.org/repos/asf/incubator-rya-site/blob/5cc07d51/content/download.md ---------------------------------------------------------------------- diff --git a/content/download.md b/content/download.md index 0fb1129..8b01d71 100644 --- a/content/download.md +++ b/content/download.md @@ -26,22 +26,14 @@ limitations under the License. ## {{ site.data.project.name }} Downloads -There are no official Apache releases for {{ site.data.project.short_name }} yet. - -First Apache Incubator release coming soon!! - If you are interested in helping out, please join our developers list [{{site.data.project.dev_list}}](mailto:{{site.data.project.dev_list_subscribe}}?subject=subscribe to Rya dev list) by sending an email to [{{site.data.project.dev_list_subscribe}}](mailto:{{site.data.project.dev_list_subscribe}}?subject=subscribe to Rya dev list). -{% comment %} - -TODO: uncoment this when we have official releases of Rya - -{{ site.data.project.name }} is released as a source artifact, and also through Maven. +{{ site.data.project.name }} is released as a source artifact, and [also through Maven](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.rya%22). ### Source releases -Release | Date | Commit | Download -:--------------- | :--------- | :------- | :------- +Release | Date | Download | Notes +:--------------- | :--------- | :------- | :---- {% for post in site.categories.release %}{% comment %} {% endcomment %}{% if post.fullVersion %}{% comment %} {% endcomment %}{% assign v = post.fullVersion %}{% comment %} @@ -49,41 +41,39 @@ Release | Date | Commit | Download {% endcomment %}{% capture v %}apache-{{ site.data.project.unix_name }}-{{ post.version }}{% endcapture %}{% comment %} {% endcomment %}{% endif %}{% comment %} {% endcomment %}{% if forloop.index0 < 2 %}{% comment %} -{% endcomment %}{% capture p %}http://www.apache.org/dyn/closer.lua?filename={{ site.data.project.unix_name }}/{{ v }}{% endcapture %}{% comment %} -{% endcomment %}{% assign q = "&action=download" %}{% comment %} -{% endcomment %}{% assign d = "https://www.apache.org/dist"; %}{% comment %} +{% endcomment %}{% capture p %}http://www.apache.org/dyn/closer.lua/{{ site.data.project.incubator_slash_name }}/{{ v }}{% endcapture %}{% comment %} +{% endcomment %}{% capture d %}https://dist.apache.org/repos/dist/release/{{ site.data.project.incubator_slash_name }}/{{ v }}{% endcapture %}{% comment %} {% endcomment %}{% else %}{% comment %} {% endcomment %}{% capture p %}http://archive.apache.org/dist/incubator/{{ site.data.project.unix_name }}/{{ v }}{% endcapture %}{% comment %} -{% endcomment %}{% assign q = "" %}{% comment %} {% endcomment %}{% assign d = "https://archive.apache.org/dist/incubator"; %}{% comment %} {% endcomment %}{% endif %}{% comment %} -{% endcomment %}<a href="{{ site.baseurl }}/history.html#{{ post.tag }}">{{ post.version }}</a>{% comment %} +{% endcomment %} <a href="{{ post.url }}">{{ post.version }}</a>{% comment %} {% endcomment %} | {{ post.date | date_to_string }}{% comment %} -{% endcomment %} | <a href="https://github.com/apache/{{ site.data.project.unix_name }}/commit/{{ post.sha }}">{{ post.sha }}</a>{% comment %} -{% endcomment %} | <a href="{{ p }}/{{ v }}-src.tar.gz{{ q }}">tar</a>{% comment %} -{% endcomment %} (<a href="{{ d }}/{{ site.data.project.unix_name }}/{{ v }}/{{ v }}-src.tar.gz.md5">md5</a>{% comment %} -{% endcomment %} <a href="{{ d }}/{{ site.data.project.unix_name }}/{{ v }}/{{ v }}-src.tar.gz.asc">pgp</a>){% comment %} -{% endcomment %} {% raw %}<br>{% endraw %}{% comment %} -{% endcomment %} <a href="{{ p }}/{{ v }}-src.zip{{ q }}">zip</a>{% comment %} -{% endcomment %} (<a href="{{ d }}/{{ site.data.project.unix_name }}/{{ v }}/{{ v }}-src.zip.md5">md5</a>{% comment %} -{% endcomment %} <a href="{{ d }}/{{ site.data.project.unix_name }}/{{ v }}/{{ v }}-src.zip.asc">pgp</a>){% comment %} -{% endcomment %} +{% endcomment %} | {% if post.filename %}{% comment %} +{% endcomment %} [zip]( {{ p }}/{{ post.filename }}.zip){% comment %} +{% endcomment %} [pgp]( {{ d }}/{{ post.filename }}.zip.asc ){% comment %} +{% endcomment %} [md5]( {{ d }}/{{ post.filename }}.zip.md5 ){% comment %} +{% endcomment %} [sha1]({{ d }}/{{ post.filename }}.zip.sha1){% comment %} +{% endcomment %}{% endif %}{% comment %} +{% endcomment %} | [Release notes]({{ post.releaseNotes }}) {% endfor %} - -Choose a source distribution in either *tar* or *zip* format, +<br> +Download a source distribution in <!-- either *tar* or --> *zip* format, and [verify](http://www.apache.org/dyn/closer.cgi#verify) -using the corresponding *pgp* signature (using the committer file in -[KEYS](http://www.apache.org/dist/{{ site.data.project.unix_name }}/KEYS)). -If you cannot do that, the *md5* hash file may be used to check that the -download has completed OK. +using the corresponding *pgp* signature (using the committer file in [KEYS](http://www.apache.org/dist/{{ site.data.project.incubator_slash_name }}/KEYS)). +If you cannot do that, the *md5* or *sha1* hash file may be used to check that the +download has completed okay. + For fast downloads, current source distributions are hosted on mirror servers; -older source distributions are in the -[archive](http://archive.apache.org/dist/incubator/{{ site.data.project.unix_name }}/). + +<!-- older source distributions are in the +[archive](http://archive.apache.org/dist/{{ site.data.project.incubator_slash_name }}/). +--> If a download from a mirror fails, retry, and the second download will likely succeed. + For security, hash and signature files are always hosted at -[Apache](https://www.apache.org/dist). +[Apache](https://www.apache.org/dist/{{ site.data.project.incubator_slash_name }}). -{% endcomment %}
