geode-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF subversion and git services (JIRA)" <>
Subject [jira] [Commented] (GEODE-1525) geode-examples rely on GEODE_HOME env variable
Date Fri, 08 Jul 2016 19:48:11 GMT


ASF subversion and git services commented on GEODE-1525:

Commit fb75348a3ded7fddb45424956cd946cf13b5a20b in incubator-geode's branch refs/heads/develop
from [~karensmolermiller]
[;h=fb75348 ]

GEODE-1525: Examples should set env variable
GEODE-1523: Improve examples markdown

This PR fixes addresses both GEODE-1525 and GEODE-1523, as they
both change the contents of the same file: geode-examples/

- Each example will likely use a scripts/ script to set
  the path to gfsh. The script depends on a GEODE_HOME environment
  variable, so this top level of instructions for setting up
  the examples now tells the user to set a GEODE_HOME env variable
  directly after the installation.

- Implement a more strict markdown that displays correctly for a
  wide variety of markdown implementations.

- Put in links for the 3 references.

- Improve the prose.

> geode-examples rely on GEODE_HOME env variable
> ----------------------------------------------
>                 Key: GEODE-1525
>                 URL:
>             Project: Geode
>          Issue Type: Bug
>          Components: docs
>            Reporter: Karen Smoler Miller
>            Assignee: Karen Smoler Miller
>              Labels: bug-hunt
> Work currently on the feature/GEODE-33 branch.
> The script {{}} in the first example (Replicated Region) relies on the user
setting the environment variable, {{GEODE_HOME}}, in order to invoke gfsh.  This is fine,
and the script would fail, telling the user to set the variable. So, things work.  
> However, it is likely that many examples will want this same env variable set. Therefore,
the top level {{}} should contain a step, perhaps directly after the link to the
installation instructions that directs a user to set a {{GEODE_HOME}} environment variable.
> Then, as more examples are added, they can copy the Replicated Region's {{}}
script and also use it.

This message was sent by Atlassian JIRA

View raw message