Merge pull request #4 from bci-oss/feature/rename-omp-to-esmf

Rename all depending files

Author: michelu89

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,7 +11,7 @@ assignees: ''
 A clear and concise description of what the bug is.
 
 **Where**
-Indicate the location of the bug (e.g., which component of the SDS SDK JS Aspect Model loader, which API call, which
+Indicate the location of the bug (e.g., which component of the ESMF SDK JS Aspect Model loader, which API call, which
 command
 etc.).
 

.github/workflows/tagged_release.yml

@@ -14,8 +14,8 @@ jobs:
       - name: Checkout project
         uses: actions/checkout@v3
 
-      - run: git config --global user.email "info@open-manufacturing.org"
-      - run: git config --global user.name "OpenManufacturing"
+      - run: git config --global user.email "info@eclipse.org"
+      - run: git config --global user.name "Eclipse Foundation
 
       - name: Cache node modules
         uses: actions/cache@v3
@@ -58,7 +58,7 @@ jobs:
           overwrite: true
           prerelease: false
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: sds-aspect-model-loader-${{ env.tagVersion }}.tgz
+          file: esmf-aspect-model-loader-${{ env.tagVersion }}.tgz
           tag: ${{ github.ref }}
 
       - name: Create GitHub pre-release
@@ -68,5 +68,5 @@ jobs:
           overwrite: true
           prerelease: true
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: sds-aspect-model-loader-${{ env.tagVersion }}.tgz
+          file: esmf-aspect-model-loader-${{ env.tagVersion }}.tgz
           tag: ${{ github.ref }}

CONTRIBUTING.md

@@ -1,13 +1,12 @@
-# SDS SDK JS Aspect Model loader Code Conventions
+# ESMF Code Conventions
 
-The following document contains a compilation of conventions and guidelines to format, structure and write code for the
-SDS SDK JS Aspect Model loader.
+The following document contains a compilation of conventions and guidelines to format, structure and
+write code for the ESMF SDK JS Aspect Model loader.
 
 ## General Conventions
 
 Our code conventions are based on the [Google Typescript Style Guide](https://google.github.io/styleguide/tsguide.html)
-but
-detailed and adjusted for the needs of the SDS SDK JS Aspect Model loader.
+but detailed and adjusted for the needs of the ESMF SDK JS Aspect Model loader.
 
 ## Copyright header
 
@@ -33,8 +32,8 @@ Developer documentation is put into a README.md placed in the project root. This
 
 ### User documentation
 
-User documentation (this includes technical documentation on how to use an application or tool from
-the SDS SDK JS Aspect Model loader) should be on
+User documentation (this includes technical documentation on how to use an application or tool from the SDK) should be
+on
 its own.
 It is written in AsciiDoc, rendered with [Antora](https://antora.org) and the generated static content is
 publically hosted for direct user access.
@@ -49,9 +48,3 @@ way more targeted towards writing fully fledged documents and with its multitude
 very good source format.
 Publishing is realized by means of [Github pages](https://docs.antora.org/antora/2.3/publish-to-github-pages/).
 
-### High Level Documentation
-
-Technical documentation targeted towards components and architecture should be accessible via the developer
-documentation.
-Corresponding discussions on design etc. can be placed in the project wiki on
-[Github](https://github.com/OpenManufacturingPlatform/sds-sdk-js-Aspect Model loader/wiki).

CONVENTIONS.md

@@ -1,4 +1,4 @@
-# SDS JS SDK :: Aspect Model Loader 🚀
+# ESMF JS SDK :: Aspect Model Loader 🚀
 
 ## Table of Contents
 
@@ -21,24 +21,20 @@ more [.ttl files](<https://en.wikipedia.org/wiki/Turtle_(syntax)>) into native T
 
 ## Getting help
 
-Are you having trouble with SDS SDK JS? We want to help!
+Are you having trouble with ESMF JS? We want to help!
 
-* Check the [developer documentation](https://openmanufacturingplatform.github.io)
-* Having issues with the SDS SDK JS? Open
-  a [GitHub issue](https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/issues).
+- Check the [developer documentation](https://openmanufacturingplatform.github.io)
+- Having issues with the ESMF JS? Open
+  a [GitHub issue](https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/issues).
 
 ## Getting started
 
-### Install from the public npm (Currently not available):
+### Install from the public npm:
 
-```
-npm install @sds/aspect-model-loader
-```
-
-### Install from github release repository:
+<!-- TODO: Replace this with esmf -->
 
 ```
-npm install https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/sds-aspect-model-loader-x.x.x.tgz
+npm install @omp-sdk/aspect-model-loader
 ```
 
 ## Usage
@@ -101,7 +97,7 @@ to update all index files under `src`. For more information see the project http
 ## Documentation
 
 Further documentation and howto's are provided in the
-official [JS SDK Aspect Model loader User Documentation](https://openmanufacturingplatform.github.io/sds-documentation/js-sdk-aml-guide/index.html)
+official [JS SDK User Documentation](https://openmanufacturingplatform.github.io/sds-documentation/js-sdk-guide/1.0.0/index.html)
 
 ## License
 
@@ -111,4 +107,3 @@ This program and the accompanying materials are made available under the terms o
 [Mozilla Public License, v. 2.0](LICENSE).
 
 The [Notice file](NOTICE.md) details contained third party materials.
-

README.md

@@ -22,14 +22,14 @@ For example a newly added property and the related value could be shown in the U
 
 [source,bash]
 ----
-npm install @sds/aspect-model-loader
+npm install @esmf/aspect-model-loader
 ----
 
 === Install from github release repository:
 
 [source,bash]
 ----
-npm install https://github.com/OpenManufacturingPlatform/sds-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/sds-aspect-model-loader-x.x.x.tgz
+npm install https://github.com/eclipse-esmf/esmf-sdk-js-aspect-model-loader/releases/download/<TAG_VERSION>/esmf-aspect-model-loader-x.x.x.tgz
 ----
 
 == Usage