[ 
https://issues.apache.org/jira/browse/GEODE-1523?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15339780#comment-15339780
 ] 

ASF subversion and git services commented on GEODE-1523:
--------------------------------------------------------

Commit 21d30ab92d2a2146207186a690eb5a36d42e7059 in incubator-geode's branch 
refs/heads/feature/GEODE-33 from [~karensmolermiller]
[ https://git-wip-us.apache.org/repos/asf?p=incubator-geode.git;h=21d30ab ]

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

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

- Each example will likely use a scripts/setEnv.sh 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 README.md markdown improvement
> ---------------------------------------------
>
>                 Key: GEODE-1523
>                 URL: https://issues.apache.org/jira/browse/GEODE-1523
>             Project: Geode
>          Issue Type: Bug
>          Components: docs
>            Reporter: Karen Smoler Miller
>            Assignee: Karen Smoler Miller
>              Labels: bug-hunt
>
> The markdown in the feature/GEODE-33 branch file {{geode-examples/README.md}} 
> is not yet right.
> There are problems with the references and with the bulleted list.
> (A separate ticket will address the content of the file.  This ticket is only 
> to fix the markdown, so it displays correctly.)



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to