edgent-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (EDGENT-323) edgent.apache.org needs refactoring for "downloads" info
Date Mon, 19 Dec 2016 17:25:58 GMT

    [ https://issues.apache.org/jira/browse/EDGENT-323?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15761757#comment-15761757

ASF GitHub Bot commented on EDGENT-323:

Github user dlaboss commented on a diff in the pull request:

    --- 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.,

> edgent.apache.org needs refactoring for "downloads" info
> --------------------------------------------------------
>                 Key: EDGENT-323
>                 URL: https://issues.apache.org/jira/browse/EDGENT-323
>             Project: Edgent
>          Issue Type: Bug
>            Reporter: Dale LaBossiere
>            Assignee: Cazen Lee
> A precursor to making a release announcement is that the project's website is updated
for the release.
> There are several places in the current edgent.apache.org dealing with downloads.  Downloads
are a bit more complicated in the ASF world -- with the official www.apache.org/dist site
(and mirrors, and dynamic resolver) for releases (with src and convenience binary bundles)
as well as the Edgent ASF git repo and mirror at github.
> We need a edgent.apache.org/downloads.html page that all other references / buttons point
to.  That page can clarify these different locations and their uses, provide a list of releases,
and release specific links (dynamic-mirror links for bundles, backup-mirror links for the
md5/sha/asc files, release-specific-github link).
> Fwiw, it seems common for ASF release announcements to refer people to <website>/downloads.html
as opposed just to the project's main page.
> Various locations related to downloads in edgent.apache.org:
> - Download Source button - links to github
> - Community tab -> Source Code - links to github
> - Getting Started tab -> Download Source - links to github
> - docs/community - "Source code" - no mention of ASF release, ...
> - docs/faq 
>   - "Where can I download..."  github and quarks-edge - see EDGENT-312 / https://github.com/apache/incubator-edgent-website/pull/80
>   - "Where can I get the code?" - links to github
> - docs/edgent-getting-started
>   - upper left says Edgent Version 0.3.0
>   - "Downloading Apache Edgent" - has link to DEVELOPMENT.md

This message was sent by Atlassian JIRA

View raw message