From 0fbf7eab1670f4c69d8f747bf07e7e10ee550e99 Mon Sep 17 00:00:00 2001 From: Gang Li Date: Wed, 20 Mar 2024 18:05:39 +0800 Subject: [PATCH] Mark sample files The files in config/ and template/ are sample files, so changed them to .sample and add README to show how to use. This will tell us they are not source code files. --- config/README | 6 ++++++ config/{aws-credentials => aws-credentials.sample} | 0 config/{charon.yaml => charon.yaml.sample} | 0 template/README | 3 +++ ...etype-catalog.xml.j2 => archetype-catalog.xml.j2.sample} | 0 template/{index.html.j2 => index.html.j2.sample} | 0 .../{maven-metadata.xml.j2 => maven-metadata.xml.j2.sample} | 0 7 files changed, 9 insertions(+) create mode 100644 config/README rename config/{aws-credentials => aws-credentials.sample} (100%) rename config/{charon.yaml => charon.yaml.sample} (100%) create mode 100644 template/README rename template/{archetype-catalog.xml.j2 => archetype-catalog.xml.j2.sample} (100%) rename template/{index.html.j2 => index.html.j2.sample} (100%) rename template/{maven-metadata.xml.j2 => maven-metadata.xml.j2.sample} (100%) diff --git a/config/README b/config/README new file mode 100644 index 00000000..239129e1 --- /dev/null +++ b/config/README @@ -0,0 +1,6 @@ +# Sample config files + +There are two sample config files here: + +* [aws-credentials.sample](./aws-credentials.sample): sample aws credentials file. It is same with aws credentials config file in official +* [charon.yaml.sample](./charon.yaml.sample): sample charon config file. You can put it into $HOME/.charon/charon.yaml and change the content by your requirements. diff --git a/config/aws-credentials b/config/aws-credentials.sample similarity index 100% rename from config/aws-credentials rename to config/aws-credentials.sample diff --git a/config/charon.yaml b/config/charon.yaml.sample similarity index 100% rename from config/charon.yaml rename to config/charon.yaml.sample diff --git a/template/README b/template/README new file mode 100644 index 00000000..46e47f9a --- /dev/null +++ b/template/README @@ -0,0 +1,3 @@ +# Sample template files to generate metadata + +These template files are used to generate related metadata accordingly. You can change based on the sample templates and then put them into $HOME/.charon/template/ to replace the default templates which are defined in charon sources. diff --git a/template/archetype-catalog.xml.j2 b/template/archetype-catalog.xml.j2.sample similarity index 100% rename from template/archetype-catalog.xml.j2 rename to template/archetype-catalog.xml.j2.sample diff --git a/template/index.html.j2 b/template/index.html.j2.sample similarity index 100% rename from template/index.html.j2 rename to template/index.html.j2.sample diff --git a/template/maven-metadata.xml.j2 b/template/maven-metadata.xml.j2.sample similarity index 100% rename from template/maven-metadata.xml.j2 rename to template/maven-metadata.xml.j2.sample