You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@edgent.apache.org by Cazen <gi...@git.apache.org> on 2016/12/17 15:46:17 UTC
[GitHub] incubator-edgent-website pull request #82: [WIP] [EDGENT-323] Create a downl...
GitHub user Cazen opened a pull request:
https://github.com/apache/incubator-edgent-website/pull/82
[WIP] [EDGENT-323] Create a download page and change links
- Created a download page(docs/downloads.html) It includes [src](http://www.apache.org/dyn/closer.lua/incubator/edgent/1.0.0-incubating/apache-edgent-1.0.0-incubating-src.tgz), [bin](http://www.apache.org/dyn/closer.lua/incubator/edgent/1.0.0-incubating/binaries/apache-edgent-1.0.0-incubating-bin.tgz) location
- Changed most of download links from github to newly created download page
- Download links cannot be direct linked in your local environment now (most of configuration use edgent domain instead of localhost address. It will be resolved after deployed to production. If you wanna to test download pages, please type http://localhost:4040/docs/downloads.html or go to docs-> Get Started -> Downloads)
I'm very newbie on website.. So please do not hesitate to advice me :) It will be great help to me
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Cazen/incubator-edgent-website EDGENT-323
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-edgent-website/pull/82.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #82
----
commit 6eadb005c81fca66c5d4c9ef59db0bd3996a6607
Author: Cazen Lee <ca...@apache.org>
Date: 2016-12-17T15:07:28Z
Add license header and align
commit 1aac4b200743890599d15daf82ef14eac457678b
Author: Cazen Lee <ca...@apache.org>
Date: 2016-12-17T15:08:11Z
Add download html page
commit 823264c6e17c1c8da6c874adde1cc7cdc7ff6b73
Author: Cazen Lee <ca...@apache.org>
Date: 2016-12-17T15:28:51Z
Change download links(github) to newly create download links
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website issue #82: [EDGENT-323] Create a download page and ...
Posted by Cazen <gi...@git.apache.org>.
Github user Cazen commented on the issue:
https://github.com/apache/incubator-edgent-website/pull/82
- I noticed that we need publish our artifacts to dist.apache.org. So download links will be changed after publishing.
- And I'm afraid that do we need a cool&nice download page that includes design rather than a simple download page under doc(doc/download.html)?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website pull request #82: [EDGENT-323] Create a download pa...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-edgent-website/pull/82#discussion_r93057962
--- Diff: site/docs/faq.md ---
@@ -44,7 +44,7 @@ Edgent is a tool for edge analytics that allows you to be more productive. Edgen
## Where can I download Apache Edgent to try it out?
-You can download the source from Apache and build it yourself [here]({{ site.data.project.source_repository_mirror }}). You can also find already pre-built Apache releases of Edgent for download [here]({{ site.data.project.apache_release_location }}) (But this location is temporarily unavailable until we get the first release out).
+You can download the source from Apache and build it yourself [here]({{ site.data.project.download }}). You can also find already pre-built Apache releases of Edgent for download [here]({{ site.data.project.apache_release_location }}) (But this location is temporarily unavailable until we get the first release out).
--- End diff --
I suggest simplifying this and adding all of the details to the downloads page. E.g., simply say "You can download Apache Edgent from --link to the downloads.html page--.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website pull request #82: [EDGENT-323] Create a download pa...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-edgent-website/pull/82#discussion_r93062810
--- Diff: site/docs/edgent-getting-started.md ---
@@ -25,7 +25,7 @@ Edgent's primary API is functional where streams are sourced, transformed, analy
### Downloading Apache Edgent
-To use Edgent, access the source code and build it. You can read more about building Edgent [here]({{ site.data.project.source_repository_mirror }}/blob/master/DEVELOPMENT.md).
+To download Edgent, please refer to [here]({{ site.data.project.download }}). And you can read more about building Edgent [here]({{ site.data.project.source_repository_mirror }}/blob/master/DEVELOPMENT.md).
--- End diff --
Suggest migrating the DEVELOPMENT.md references to downloads.html and also clarifying the getting-started options here. e.g., replacing the "To use/download Edgent,..." with something like:
"To use Edgent you need the Edgent jars. You can either download the Edgent source and build it or you can download a pre-built version of Edgent. See the --downloads page link--.
Below... "After you build the Edgent package, you ..." change to something like "After you have the Edgent jars, you ..."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website issue #82: [EDGENT-323] Create a download page and ...
Posted by Cazen <gi...@git.apache.org>.
Github user Cazen commented on the issue:
https://github.com/apache/incubator-edgent-website/pull/82
@dlaboss Thank you for detailed guide.
I will reflect your requirements soon
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website pull request #82: [EDGENT-323] Create a download pa...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-edgent-website/pull/82
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website pull request #82: [EDGENT-323] Create a download pa...
Posted by justinmclean <gi...@git.apache.org>.
Github user justinmclean commented on a diff in the pull request:
https://github.com/apache/incubator-edgent-website/pull/82#discussion_r93351844
--- Diff: site/docs/downloads.md ---
@@ -0,0 +1,13 @@
+---
+title: Downloads
+---
+
--- End diff --
you might also want to add a link to the KEYS and asc files so the releases can be verified.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website pull request #82: [EDGENT-323] Create a download pa...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-edgent-website/pull/82#discussion_r93078422
--- Diff: site/docs/downloads.md ---
@@ -0,0 +1,13 @@
+---
+title: Downloads
+---
+
--- End diff --
Suggest adding some clarification of the various download options and uses:
- source bundle from ASF release distribution site
- binary bundle from ASF release site (includes javadoc, can also access online)
- ASF git repo
- git repo mirror on github
Perhaps something like:
Official Apache Edgent releases are available for download from the ASF distribution site. A release consists of a source code bundle and a convenience binary bundle. The Edgent ASF distribution site is --the-dyn-mirror-script-to-incubator/edgent--. Information about verifying the integrity of the release bundles can also be found there.
The Edgent source is also available from the Edgent ASF git repository --the-url-- or its mirror on github --the-url--.
If you just want to use Edgent, it is easiest to download and unpack a binary bundle. The bundle includes the release's javadoc. The javadoc is also accessible online. maybe simple unpack example here and/or link to getting-started?
A source bundle contains a README describing how to build the sources.
If you want access the latest unreleased Edgent source or to contribute to Edgent runtime development, using the github repository is recommended. You can also select a particular release version by release tag (e.g., 1.0.0-incubating). See README.md and DEVELOPMENT.md in the repository for more information.
See --our-contributing-page-url-- for more information about contributing to Edgent development.
----
Of course the above and the information in getting-started, needs to flow well. No guarantee the above achieves that :-/
----
In the table below I'm wondering if it is better to NOT have links to tgz files. Might it be better to just supply a link to the dyn-url-incubating/edgent/1.0.0-incubating dir? Then the README, RELEASE_NOTES, LICENSING files will also be in their face. Hopefully the "binaries" dir (containing its LICENSE) will be obvious enough. So combining the Source and Binaries columns into just Distribution Site or such. Of course all of those files are in the bundles themselves so perhaps I'm just worrying too much about that?
Adding a release-specific url to the github site seems like it could be helpful? e.g., https://github.com/apache/incubator-edgent/tree/1.0.0-incubating
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website issue #82: [EDGENT-323] Create a download page and ...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on the issue:
https://github.com/apache/incubator-edgent-website/pull/82
[~Cazen] thanks for picking up this jira! (and your other deliveries the last couple of days)
I sent a clarifying note to @dev regarding the location of the release artifacts. Hope that clears some things up: https://www.mail-archive.com/dev@edgent.apache.org/msg00933.html.
Yes, a cool&nice page is highly desired I think. If that can be achieved in a day or two that would be great. Otherwise a quick/simple first-iteration page will allow making the release announcement sooner and the page can be enhanced after the fact.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-edgent-website issue #82: [EDGENT-323] Create a download page and ...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on the issue:
https://github.com/apache/incubator-edgent-website/pull/82
+1 thanks!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---