[
https://issues.apache.org/jira/browse/GEODE-5554?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
ASF GitHub Bot updated GEODE-5554:
----------------------------------
Labels: pull-request-available (was: )
> Standardize naming of Geode Native example *.md files
> -----------------------------------------------------
>
> Key: GEODE-5554
> URL: https://issues.apache.org/jira/browse/GEODE-5554
> Project: Geode
> Issue Type: Sub-task
> Components: docs, native client
> Reporter: Dave Barnes
> Assignee: Dave Barnes
> Priority: Major
> Labels: pull-request-available
>
> The *.md files describing how to build and run examples do not follow a
> consistent naming pattern. Current state:
> * examples/dotnet/README.md describes building examples, refers user to
> README.md in each example directory for running.
> * examples/cpp/BUILDING.md describes building examples and running them.
> Only one individual example has its own README.md file.
> Problems:
> * Top-level file in dotnet should have 'BUILD' in its name.
> * The geode-native distribution has a 'BUILDING.md' in its root directory.
> Top-level files in both dotnet and cpp should not be named 'BUILDING.md',
> because it's confusing to the user when both are open on the desktop at the
> same time.
> * The cpp examples should follow the dotnet pattern of an individual
> README.md for each example with instructions for running.
> * The cpp examples should follow the practice recommended for the dotnet
> examples of copying the installed example to a personal workspace before
> building and running. This practice preserves a clean copy from which the
> user can start over, if necessary.
> Recommendations:
> * Rename example build instructions to BUILD-EXAMPLES.md for both dotnet and
> cpp
> * Add README.md to individual cpp examples
> * Update all CMake scripts to deploy these *.md files when examples are
> installed.
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
