diff --git a/404.html b/404.html index c371f49..c48f371 100644 --- a/404.html +++ b/404.html @@ -4,13 +4,13 @@ Page Not Found | Solution Center Java Starter Project - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/105b1668.42a712dc.js b/assets/js/105b1668.42a712dc.js new file mode 100644 index 0000000..72c9a74 --- /dev/null +++ b/assets/js/105b1668.42a712dc.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[242],{3905:(e,t,n)=>{n.d(t,{Zo:()=>d,kt:()=>f});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var u=r.createContext({}),s=function(e){var t=r.useContext(u),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},d=function(e){var t=s(e.components);return r.createElement(u.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},m=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,i=e.originalType,u=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=s(n),m=a,f=c["".concat(u,".").concat(m)]||c[m]||p[m]||i;return n?r.createElement(f,l(l({ref:t},d),{},{components:n})):r.createElement(f,l({ref:t},d))}));function f(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var i=n.length,l=new Array(i);l[0]=m;var o={};for(var u in t)hasOwnProperty.call(t,u)&&(o[u]=t[u]);o.originalType=e,o[c]="string"==typeof e?e:a,l[1]=o;for(var s=2;s{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>p,frontMatter:()=>i,metadata:()=>o,toc:()=>s});var r=n(7462),a=(n(7294),n(3905));const i={id:"change-log",title:"Change Log",sidebar_label:"Change Log",toc_max_heading_level:2},l=void 0,o={unversionedId:"change-log",id:"change-log",title:"Change Log",description:"Version X.Y.Z",source:"@site/docs/02-CHANGELOG.mdx",sourceDirName:".",slug:"/change-log",permalink:"/sc-java-maven-starter-project/docs/change-log",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/02-CHANGELOG.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"change-log",title:"Change Log",sidebar_label:"Change Log",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Introduction",permalink:"/sc-java-maven-starter-project/docs/"},next:{title:"Quick Start Guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide"}},u={},s=[{value:"Version X.Y.Z",id:"version-xyz",level:2},{value:"Features",id:"features",level:3},{value:"Version 0.0.5",id:"version-005",level:2},{value:"Features",id:"features-1",level:3},{value:"Bug Fixes",id:"bug-fixes",level:3},{value:"Version 0.0.4",id:"version-004",level:2},{value:"Features",id:"features-2",level:3},{value:"Version 0.0.3",id:"version-003",level:2},{value:"Features",id:"features-3",level:3},{value:"Bug Fixes",id:"bug-fixes-1",level:3},{value:"Other",id:"other",level:3},{value:"Version 0.0.2",id:"version-002",level:2},{value:"Features",id:"features-4",level:3},{value:"Bug Fixes",id:"bug-fixes-2",level:3},{value:"Other",id:"other-1",level:3},{value:"Version 0.0.1",id:"version-001",level:2},{value:"Features",id:"features-5",level:3},{value:"Bug Fixes",id:"bug-fixes-3",level:3},{value:"Other",id:"other-2",level:3}],d={toc:s},c="wrapper";function p(e){let{components:t,...n}=e;return(0,a.kt)(c,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"version-xyz"},"Version X.Y.Z"),(0,a.kt)("h3",{id:"features"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added configFileName to ScDocusaurusConfig.js",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Documentation now has access to reference the config file name as a configurable parameter"))),(0,a.kt)("li",{parentName:"ul"},"Added applicationJarFileName to ScDocusaurusConfig.js",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Documentation now has access to reference the generated JAR file name as a configurable parameter")))),(0,a.kt)("h2",{id:"version-005"},"Version 0.0.5"),(0,a.kt)("h3",{id:"features-1"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added Checkstyle configuration for code style and formatting enforcement",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Integrated Checkstyle into Maven build process")))),(0,a.kt)("h3",{id:"bug-fixes"},"Bug Fixes"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed incorrect version number in ",(0,a.kt)("inlineCode",{parentName:"li"},"commit-format-check.yml")," GitHub Actions workflow")),(0,a.kt)("h2",{id:"version-004"},"Version 0.0.4"),(0,a.kt)("h3",{id:"features-2"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Javadoc warnings now trigger build failure to ensure documentation quality")),(0,a.kt)("h2",{id:"version-003"},"Version 0.0.3"),(0,a.kt)("h3",{id:"features-3"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Improved code style and formatting configurations for IntelliJ and Eclipse IDEs",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Added IDE code style configuration information to documentation"))),(0,a.kt)("li",{parentName:"ul"},"Added a Popover component for web documentation, ",(0,a.kt)("inlineCode",{parentName:"li"},"popover.js")),(0,a.kt)("li",{parentName:"ul"},"Added a Highlight component for web documentation, ",(0,a.kt)("inlineCode",{parentName:"li"},"highlight.js"))),(0,a.kt)("h3",{id:"bug-fixes-1"},"Bug Fixes"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Fixed VS Code tasks.json Maven commands"),(0,a.kt)("li",{parentName:"ul"},"Standardized newlines in documentation"),(0,a.kt)("li",{parentName:"ul"},"Corrected default debugger IP addresses in IDE configuration files to match the default in\nthe ",(0,a.kt)("inlineCode",{parentName:"li"},"flexy.properties")," file"),(0,a.kt)("li",{parentName:"ul"},"Fixed missing Jar file in artifacts from ",(0,a.kt)("inlineCode",{parentName:"li"},"release-build-outputs.yml")," GitHub Actions workflow")),(0,a.kt)("h3",{id:"other"},"Other"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Updated IntelliJ IDE configuration files to latest formats"),(0,a.kt)("li",{parentName:"ul"},"Organized Eclipse IDE configuration files under ",(0,a.kt)("inlineCode",{parentName:"li"},".eclipse")," directory")),(0,a.kt)("h2",{id:"version-002"},"Version 0.0.2"),(0,a.kt)("h3",{id:"features-4"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Added example configuration file"),(0,a.kt)("li",{parentName:"ul"},"Added external Flexy properties file"),(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"jvmrun")," file autofill from ",(0,a.kt)("inlineCode",{parentName:"li"},"pom.xml")),(0,a.kt)("li",{parentName:"ul"},"Improved documentation and migrated to Docusaurus"),(0,a.kt)("li",{parentName:"ul"},"Improved GitHub Actions workflows",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Added ",(0,a.kt)("inlineCode",{parentName:"li"},"jvmrun")," file line-ending normalization"),(0,a.kt)("li",{parentName:"ul"},"Updated to latest plugin/action versions to resolve warnings")))),(0,a.kt)("h3",{id:"bug-fixes-2"},"Bug Fixes"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Resolved warnings due to deprecation of utilized GitHub Actions dependencies"),(0,a.kt)("li",{parentName:"ul"},"Removed the stray/trailing NUL character from release bodies")),(0,a.kt)("h3",{id:"other-1"},"Other"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Excluded Ewon ETK from generated Javadocs")),(0,a.kt)("h2",{id:"version-001"},"Version 0.0.1"),(0,a.kt)("h3",{id:"features-5"},"Features"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Initial Release")),(0,a.kt)("h3",{id:"bug-fixes-3"},"Bug Fixes"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"N/A")),(0,a.kt)("h3",{id:"other-2"},"Other"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"N/A")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/105b1668.5b8be9d8.js b/assets/js/105b1668.5b8be9d8.js deleted file mode 100644 index 6a5eda7..0000000 --- a/assets/js/105b1668.5b8be9d8.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[242],{3905:(e,t,r)=>{r.d(t,{Zo:()=>d,kt:()=>f});var n=r(7294);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(i[r]=e[r]);return i}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(i[r]=e[r])}return i}var u=n.createContext({}),s=function(e){var t=n.useContext(u),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},d=function(e){var t=s(e.components);return n.createElement(u.Provider,{value:t},e.children)},c="mdxType",p={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,i=e.mdxType,a=e.originalType,u=e.parentName,d=o(e,["components","mdxType","originalType","parentName"]),c=s(r),m=i,f=c["".concat(u,".").concat(m)]||c[m]||p[m]||a;return r?n.createElement(f,l(l({ref:t},d),{},{components:r})):n.createElement(f,l({ref:t},d))}));function f(e,t){var r=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var a=r.length,l=new Array(a);l[0]=m;var o={};for(var u in t)hasOwnProperty.call(t,u)&&(o[u]=t[u]);o.originalType=e,o[c]="string"==typeof e?e:i,l[1]=o;for(var s=2;s{r.r(t),r.d(t,{assets:()=>u,contentTitle:()=>l,default:()=>p,frontMatter:()=>a,metadata:()=>o,toc:()=>s});var n=r(7462),i=(r(7294),r(3905));const a={id:"change-log",title:"Change Log",sidebar_label:"Change Log",toc_max_heading_level:2},l=void 0,o={unversionedId:"change-log",id:"change-log",title:"Change Log",description:"Version X.Y.Z",source:"@site/docs/02-CHANGELOG.mdx",sourceDirName:".",slug:"/change-log",permalink:"/sc-java-maven-starter-project/docs/change-log",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/02-CHANGELOG.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"change-log",title:"Change Log",sidebar_label:"Change Log",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Introduction",permalink:"/sc-java-maven-starter-project/docs/"},next:{title:"Quick Start Guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide"}},u={},s=[{value:"Version X.Y.Z",id:"version-xyz",level:2},{value:"Features",id:"features",level:3},{value:"Version 0.0.5",id:"version-005",level:2},{value:"Features",id:"features-1",level:3},{value:"Bug Fixes",id:"bug-fixes",level:3},{value:"Version 0.0.4",id:"version-004",level:2},{value:"Features",id:"features-2",level:3},{value:"Version 0.0.3",id:"version-003",level:2},{value:"Features",id:"features-3",level:3},{value:"Bug Fixes",id:"bug-fixes-1",level:3},{value:"Other",id:"other",level:3},{value:"Version 0.0.2",id:"version-002",level:2},{value:"Features",id:"features-4",level:3},{value:"Bug Fixes",id:"bug-fixes-2",level:3},{value:"Other",id:"other-1",level:3},{value:"Version 0.0.1",id:"version-001",level:2},{value:"Features",id:"features-5",level:3},{value:"Bug Fixes",id:"bug-fixes-3",level:3},{value:"Other",id:"other-2",level:3}],d={toc:s},c="wrapper";function p(e){let{components:t,...r}=e;return(0,i.kt)(c,(0,n.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"version-xyz"},"Version X.Y.Z"),(0,i.kt)("h3",{id:"features"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Added configFileName to ScDocusaurusConfig.js",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Documentation now has access to refrence the config file name as a configurable parameter")))),(0,i.kt)("h2",{id:"version-005"},"Version 0.0.5"),(0,i.kt)("h3",{id:"features-1"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Added Checkstyle configuration for code style and formatting enforcement",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Integrated Checkstyle into Maven build process")))),(0,i.kt)("h3",{id:"bug-fixes"},"Bug Fixes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Fixed incorrect version number in ",(0,i.kt)("inlineCode",{parentName:"li"},"commit-format-check.yml")," GitHub Actions workflow")),(0,i.kt)("h2",{id:"version-004"},"Version 0.0.4"),(0,i.kt)("h3",{id:"features-2"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Javadoc warnings now trigger build failure to ensure documentation quality")),(0,i.kt)("h2",{id:"version-003"},"Version 0.0.3"),(0,i.kt)("h3",{id:"features-3"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Improved code style and formatting configurations for IntelliJ and Eclipse IDEs",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Added IDE code style configuration information to documentation"))),(0,i.kt)("li",{parentName:"ul"},"Added a Popover component for web documentation, ",(0,i.kt)("inlineCode",{parentName:"li"},"popover.js")),(0,i.kt)("li",{parentName:"ul"},"Added a Highlight component for web documentation, ",(0,i.kt)("inlineCode",{parentName:"li"},"highlight.js"))),(0,i.kt)("h3",{id:"bug-fixes-1"},"Bug Fixes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Fixed VS Code tasks.json Maven commands"),(0,i.kt)("li",{parentName:"ul"},"Standardized newlines in documentation"),(0,i.kt)("li",{parentName:"ul"},"Corrected default debugger IP addresses in IDE configuration files to match the default in\nthe ",(0,i.kt)("inlineCode",{parentName:"li"},"flexy.properties")," file"),(0,i.kt)("li",{parentName:"ul"},"Fixed missing Jar file in artifacts from ",(0,i.kt)("inlineCode",{parentName:"li"},"release-build-outputs.yml")," GitHub Actions workflow")),(0,i.kt)("h3",{id:"other"},"Other"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Updated IntelliJ IDE configuration files to latest formats"),(0,i.kt)("li",{parentName:"ul"},"Organized Eclipse IDE configuration files under ",(0,i.kt)("inlineCode",{parentName:"li"},".eclipse")," directory")),(0,i.kt)("h2",{id:"version-002"},"Version 0.0.2"),(0,i.kt)("h3",{id:"features-4"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Added example configuration file"),(0,i.kt)("li",{parentName:"ul"},"Added external Flexy properties file"),(0,i.kt)("li",{parentName:"ul"},"Added ",(0,i.kt)("inlineCode",{parentName:"li"},"jvmrun")," file autofill from ",(0,i.kt)("inlineCode",{parentName:"li"},"pom.xml")),(0,i.kt)("li",{parentName:"ul"},"Improved documentation and migrated to Docusaurus"),(0,i.kt)("li",{parentName:"ul"},"Improved GitHub Actions workflows",(0,i.kt)("ul",{parentName:"li"},(0,i.kt)("li",{parentName:"ul"},"Added ",(0,i.kt)("inlineCode",{parentName:"li"},"jvmrun")," file line-ending normalization"),(0,i.kt)("li",{parentName:"ul"},"Updated to latest plugin/action versions to resolve warnings")))),(0,i.kt)("h3",{id:"bug-fixes-2"},"Bug Fixes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Resolved warnings due to deprecation of utilized GitHub Actions dependencies"),(0,i.kt)("li",{parentName:"ul"},"Removed the stray/trailing NUL character from release bodies")),(0,i.kt)("h3",{id:"other-1"},"Other"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Excluded Ewon ETK from generated Javadocs")),(0,i.kt)("h2",{id:"version-001"},"Version 0.0.1"),(0,i.kt)("h3",{id:"features-5"},"Features"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Initial Release")),(0,i.kt)("h3",{id:"bug-fixes-3"},"Bug Fixes"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"N/A")),(0,i.kt)("h3",{id:"other-2"},"Other"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"N/A")))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1df93b7f.17de39b0.js b/assets/js/1df93b7f.17de39b0.js new file mode 100644 index 0000000..a5955b7 --- /dev/null +++ b/assets/js/1df93b7f.17de39b0.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[237],{8979:e=>{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},6735:(e,t,a)=>{"use strict";a.r(t),a.d(t,{default:()=>v});var o=a(7294),n=a(6010),r=a(9960),c=a(2263),s=a(7961),l=a(7462);const i={features:"features_t9lD",featureSvg:"featureSvg_GfXr"},m=a.p+"assets/images/plc-animation-e90f2660ec380bd4265a39ebced1e6c9.gif",u=a.p+"assets/images/ewon-connections-e3dd4be3d4a7bd1f773dc3f34a1680f3.webp",d=a.p+"assets/images/ewon-azure-connection-features-81317841f0ef261c8c0c8e9d907acc8b.webp";var p=a(8979),h=a.n(p);const f=[{title:"Harness the power of your industrial machines",imgSrc:m,description:o.createElement(o.Fragment,null,"The Ewon Flexy is able to perform data acquisition with the following protocols: Modbus RTU, Modbus TCP, Uni-Telway, EtherNet/IP, DF1, FINS TCP, FINS Hostlink, ISO TCP, PPI, MPI, Profibus, Mitsubishi FX, Hitachi EH, ASCII.")},{title:"Easy Connections to Cloud Platforms!",imgSrc:u,description:o.createElement(o.Fragment,null,"You can connect your Flexy to different clouds, including Talk2M Direct connection to Azure IoT Hub (Microsoft) and AWS IoT (Amazon) are also possible, even if you want to use Talk2M, our Flexy is certified to connect to these other clouds.")},{title:o.createElement(o.Fragment,null,"Leverage the power of the ",h().title," to gain productivity insights"),imgSrc:d,description:o.createElement(o.Fragment,null,"With your machine data connected via the ",h().title,", you can now make use of the vast collection of features and modules to gain productivity insights, control your factory floor, and much more!")}];function b(e){let{title:t,imgSrc:a,description:r}=e;return o.createElement("div",{className:(0,n.Z)("col col--4")},o.createElement("div",{className:"text--center"},o.createElement("img",{className:i.featureSvg,src:a})),o.createElement("div",{className:"text--center padding-horiz--md"},o.createElement("h3",null,t),o.createElement("p",null,r)))}function g(){return o.createElement("section",{className:i.features},o.createElement("div",{className:"container"},o.createElement("div",{className:"row"},f.map(((e,t)=>o.createElement(b,(0,l.Z)({key:t},e)))))))}const N={heroBanner:"heroBanner_qdFl",buttons:"buttons_AeoN"},E=a(8979);function w(){const{siteConfig:e}=(0,c.Z)();return o.createElement("header",{className:(0,n.Z)("hero hero--primary",N.heroBanner)},o.createElement("div",{className:"container"},o.createElement("h1",{className:"hero__title"},e.title),o.createElement("p",{className:"hero__subtitle"},e.tagline),o.createElement("br",null),o.createElement("div",{className:N.buttons},o.createElement(r.Z,{className:"button button--secondary button--lg",to:"/docs"},"Documentation"),o.createElement(r.Z,{className:"button button--secondary button--lg",to:"/docs/quick-start-guide"},"Quick Start Guide"),o.createElement(r.Z,{className:"button button--secondary button--lg",to:E.repoLatestReleaseUrl},"Download"),o.createElement(r.Z,{className:"button button--secondary button--lg",to:E.repoUrl},"Source Code"))))}function v(){const{siteConfig:e}=(0,c.Z)();return o.createElement(s.Z,{title:"Home",description:E.meta},o.createElement(w,null),o.createElement("main",null,o.createElement(g,null)))}}}]); \ No newline at end of file diff --git a/assets/js/1df93b7f.f206fa94.js b/assets/js/1df93b7f.f206fa94.js deleted file mode 100644 index ec64ff6..0000000 --- a/assets/js/1df93b7f.f206fa94.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[237],{8979:e=>{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},6735:(e,t,o)=>{"use strict";o.r(t),o.d(t,{default:()=>v});var a=o(7294),n=o(6010),r=o(9960),c=o(2263),s=o(7961),l=o(7462);const i={features:"features_t9lD",featureSvg:"featureSvg_GfXr"},m=o.p+"assets/images/plc-animation-e90f2660ec380bd4265a39ebced1e6c9.gif",u=o.p+"assets/images/ewon-connections-e3dd4be3d4a7bd1f773dc3f34a1680f3.webp",d=o.p+"assets/images/ewon-azure-connection-features-81317841f0ef261c8c0c8e9d907acc8b.webp";var p=o(8979),h=o.n(p);const f=[{title:"Harness the power of your industrial machines",imgSrc:m,description:a.createElement(a.Fragment,null,"The Ewon Flexy is able to perform data acquisition with the following protocols: Modbus RTU, Modbus TCP, Uni-Telway, EtherNet/IP, DF1, FINS TCP, FINS Hostlink, ISO TCP, PPI, MPI, Profibus, Mitsubishi FX, Hitachi EH, ASCII.")},{title:"Easy Connections to Cloud Platforms!",imgSrc:u,description:a.createElement(a.Fragment,null,"You can connect your Flexy to different clouds, including Talk2M Direct connection to Azure IoT Hub (Microsoft) and AWS IoT (Amazon) are also possible, even if you want to use Talk2M, our Flexy is certified to connect to these other clouds.")},{title:a.createElement(a.Fragment,null,"Leverage the power of the ",h().title," to gain productivity insights"),imgSrc:d,description:a.createElement(a.Fragment,null,"With your machine data connected via the ",h().title,", you can now make use of the vast collection of features and modules to gain productivity insights, control your factory floor, and much more!")}];function b(e){let{title:t,imgSrc:o,description:r}=e;return a.createElement("div",{className:(0,n.Z)("col col--4")},a.createElement("div",{className:"text--center"},a.createElement("img",{className:i.featureSvg,src:o})),a.createElement("div",{className:"text--center padding-horiz--md"},a.createElement("h3",null,t),a.createElement("p",null,r)))}function g(){return a.createElement("section",{className:i.features},a.createElement("div",{className:"container"},a.createElement("div",{className:"row"},f.map(((e,t)=>a.createElement(b,(0,l.Z)({key:t},e)))))))}const E={heroBanner:"heroBanner_qdFl",buttons:"buttons_AeoN"},N=o(8979);function w(){const{siteConfig:e}=(0,c.Z)();return a.createElement("header",{className:(0,n.Z)("hero hero--primary",E.heroBanner)},a.createElement("div",{className:"container"},a.createElement("h1",{className:"hero__title"},e.title),a.createElement("p",{className:"hero__subtitle"},e.tagline),a.createElement("br",null),a.createElement("div",{className:E.buttons},a.createElement(r.Z,{className:"button button--secondary button--lg",to:"/docs"},"Documentation"),a.createElement(r.Z,{className:"button button--secondary button--lg",to:"/docs/quick-start-guide"},"Quick Start Guide"),a.createElement(r.Z,{className:"button button--secondary button--lg",to:N.repoLatestReleaseUrl},"Download"),a.createElement(r.Z,{className:"button button--secondary button--lg",to:N.repoUrl},"Source Code"))))}function v(){const{siteConfig:e}=(0,c.Z)();return a.createElement(s.Z,{title:"Home",description:N.meta},a.createElement(w,null),a.createElement("main",null,a.createElement(g,null)))}}}]); \ No newline at end of file diff --git a/assets/js/1f6bea8b.33d55812.js b/assets/js/1f6bea8b.33d55812.js new file mode 100644 index 0000000..f18ac6f --- /dev/null +++ b/assets/js/1f6bea8b.33d55812.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[579],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>c,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),p=u(r),h=o,d=p["".concat(l,".").concat(h)]||p[h]||m[h]||a;return r?n.createElement(d,i(i({ref:t},c),{},{components:r})):n.createElement(d,i({ref:t},c))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},1970:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>u,default:()=>f,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var n=r(7462),o=r(7294),a=r(3905),i=r(8979),s=r.n(i);const l={id:"faq",title:"Frequently Asked Questions",sidebar_label:"Frequently Asked Questions"},u=void 0,c={unversionedId:"help/faq",id:"help/faq",title:"Frequently Asked Questions",description:"1. How do I import template changes into my project?",source:"@site/docs/06-help/01-FAQ.mdx",sourceDirName:"06-help",slug:"/help/faq",permalink:"/sc-java-maven-starter-project/docs/help/faq",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/01-FAQ.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"faq",title:"Frequently Asked Questions",sidebar_label:"Frequently Asked Questions"},sidebar:"defaultSidebar",previous:{title:"System Requirements",permalink:"/sc-java-maven-starter-project/docs/usage/system-requirements"},next:{title:"Troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting"}},p={},m=[{value:"1. How do I import template changes into my project?",id:"1-how-do-i-import-template-changes-into-my-project",level:2},{value:"2. Where can I learn more about Docusaurus?",id:"2-where-can-i-learn-more-about-docusaurus",level:2},{value:"3. Where can I learn more about Maven?",id:"3-where-can-i-learn-more-about-maven",level:2}],h={toc:m},d="wrapper";function f(e){let{components:t,...r}=e;return(0,a.kt)(d,(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"1-how-do-i-import-template-changes-into-my-project"},"1. How do I import template changes into my project?"),(0,a.kt)("p",null,"When a new version of the template is released, you can import the changes, or a selection of the\nchanges, in to your project."),(0,a.kt)("p",null,"This can be completed by configuring the template as a remote repository, and then pulling the\nchanges from the template into your project. Depending on the changes you want to import, you may\nneed to resolve merge conflicts."),(0,a.kt)("p",null,"Detailed information on how to configure the template as a remote repository can be found in the\nGitHub\ndocumentation, ",(0,a.kt)("a",{parentName:"p",href:"https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"},"Configuring a remote for a fork"),"."),(0,a.kt)("p",null,"Detailed information on how to pull changes from the template into your project can be found in the\nGitHub\ndocumentation, ",(0,a.kt)("a",{parentName:"p",href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-command-line"},"Syncing a fork"),"."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Please note that while GitHub templates are similar to a normal fork of the repository, the option\nto 'sync' may be unavailable on the GitHub website and CLI. Repositories created from a template do\nnot contain the full upstream history, and therefore cannot be synced in the same way as a normal\nfork."),(0,a.kt)("li",{parentName:"ul"},"Instead, you will need to follow the steps outlined to merge the changes from the template\ninto your project.")),(0,a.kt)("h2",{id:"2-where-can-i-learn-more-about-docusaurus"},"2. Where can I learn more about Docusaurus?"),(0,a.kt)(o.Fragment,null,"Docusaurus is a static site generator that is used to build the documentation for the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"Additional information about Docusaurus can be found on the Docusaurus website,\n",(0,a.kt)("a",{parentName:"p",href:"https://docusaurus.io/"},"https://docusaurus.io/"),"."),(0,a.kt)("h2",{id:"3-where-can-i-learn-more-about-maven"},"3. Where can I learn more about Maven?"),(0,a.kt)(o.Fragment,null,"Maven is the build automation tool that is used to build the Java application and associated dependencies for the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"Additional information about Maven can be found on the Maven website,\n",(0,a.kt)("a",{parentName:"p",href:"https://maven.apache.org/"},"https://maven.apache.org/"),"."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/1f6bea8b.d042b4dc.js b/assets/js/1f6bea8b.d042b4dc.js deleted file mode 100644 index eb0abee..0000000 --- a/assets/js/1f6bea8b.d042b4dc.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[579],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>c,kt:()=>d});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),u=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},c=function(e){var t=u(e.components);return n.createElement(l.Provider,{value:t},e.children)},p="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},h=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),p=u(r),h=o,d=p["".concat(l,".").concat(h)]||p[h]||m[h]||a;return r?n.createElement(d,i(i({ref:t},c),{},{components:r})):n.createElement(d,i({ref:t},c))}));function d(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=h;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[p]="string"==typeof e?e:o,i[1]=s;for(var u=2;u{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},1970:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>p,contentTitle:()=>u,default:()=>f,frontMatter:()=>l,metadata:()=>c,toc:()=>m});var n=r(7462),o=r(7294),a=r(3905),i=r(8979),s=r.n(i);const l={id:"faq",title:"Frequently Asked Questions",sidebar_label:"Frequently Asked Questions"},u=void 0,c={unversionedId:"help/faq",id:"help/faq",title:"Frequently Asked Questions",description:"1. How do I import template changes into my project?",source:"@site/docs/06-help/01-FAQ.mdx",sourceDirName:"06-help",slug:"/help/faq",permalink:"/sc-java-maven-starter-project/docs/help/faq",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/01-FAQ.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"faq",title:"Frequently Asked Questions",sidebar_label:"Frequently Asked Questions"},sidebar:"defaultSidebar",previous:{title:"System Requirements",permalink:"/sc-java-maven-starter-project/docs/usage/system-requirements"},next:{title:"Troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting"}},p={},m=[{value:"1. How do I import template changes into my project?",id:"1-how-do-i-import-template-changes-into-my-project",level:2},{value:"2. Where can I learn more about Docusaurus?",id:"2-where-can-i-learn-more-about-docusaurus",level:2},{value:"3. Where can I learn more about Maven?",id:"3-where-can-i-learn-more-about-maven",level:2}],h={toc:m},d="wrapper";function f(e){let{components:t,...r}=e;return(0,a.kt)(d,(0,n.Z)({},h,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"1-how-do-i-import-template-changes-into-my-project"},"1. How do I import template changes into my project?"),(0,a.kt)("p",null,"When a new version of the template is released, you can import the changes, or a selection of the\nchanges, in to your project."),(0,a.kt)("p",null,"This can be completed by configuring the template as a remote repository, and then pulling the\nchanges from the template into your project. Depending on the changes you want to import, you may\nneed to resolve merge conflicts."),(0,a.kt)("p",null,"Detailed information on how to configure the template as a remote repository can be found in the\nGitHub\ndocumentation, ",(0,a.kt)("a",{parentName:"p",href:"https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/configuring-a-remote-for-a-fork"},"Configuring a remote for a fork"),"."),(0,a.kt)("p",null,"Detailed information on how to pull changes from the template into your project can be found in the\nGitHub\ndocumentation, ",(0,a.kt)("a",{parentName:"p",href:"https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork#syncing-a-fork-branch-from-the-command-line"},"Syncing a fork"),"."),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"Please note that while GitHub templates are similar to a normal fork of the repository, the option\nto 'sync' may be unavailable on the GitHub website and CLI. Repositories created from a template do\nnot contain the full upstream history, and therefore cannot be synced in the same way as a normal\nfork."),(0,a.kt)("li",{parentName:"ul"},"Instead, you will need to follow the steps outlined to merge the changes from the template\ninto your project.")),(0,a.kt)("h2",{id:"2-where-can-i-learn-more-about-docusaurus"},"2. Where can I learn more about Docusaurus?"),(0,a.kt)(o.Fragment,null,"Docusaurus is a static site generator that is used to build the documentation for the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"Additional information about Docusaurus can be found on the Docusaurus website,\n",(0,a.kt)("a",{parentName:"p",href:"https://docusaurus.io/"},"https://docusaurus.io/"),"."),(0,a.kt)("h2",{id:"3-where-can-i-learn-more-about-maven"},"3. Where can I learn more about Maven?"),(0,a.kt)(o.Fragment,null,"Maven is the build automation tool that is used to build the Java application and associated dependencies for the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"Additional information about Maven can be found on the Maven website,\n",(0,a.kt)("a",{parentName:"p",href:"https://maven.apache.org/"},"https://maven.apache.org/"),"."))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/235622ac.0c1f6eca.js b/assets/js/235622ac.0c1f6eca.js new file mode 100644 index 0000000..46a727a --- /dev/null +++ b/assets/js/235622ac.0c1f6eca.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[243],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>d,kt:()=>v});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=p(n),m=i,v=c["".concat(s,".").concat(m)]||c[m]||u[m]||r;return n?a.createElement(v,o(o({ref:t},d),{},{components:n})):a.createElement(v,o({ref:t},d))}));function v(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},8322:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>u});var a=n(7462),i=(n(7294),n(3905)),r=(n(8979),n(2919)),o=n(7712),l=n(9958);const s={id:"development-environment",title:"Development Environment Information",sidebar_label:"Development Environment Information"},p=void 0,d={unversionedId:"developer/development-environment",id:"developer/development-environment",title:"Development Environment Information",description:"IDEs",source:"@site/docs/08-developer/01-DEVELOPMENT_ENVIRONMENT.mdx",sourceDirName:"08-developer",slug:"/developer/development-environment",permalink:"/sc-java-maven-starter-project/docs/developer/development-environment",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/08-developer/01-DEVELOPMENT_ENVIRONMENT.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"development-environment",title:"Development Environment Information",sidebar_label:"Development Environment Information"},sidebar:"defaultSidebar",previous:{title:"License",permalink:"/sc-java-maven-starter-project/docs/legal/license"},next:{title:"Libraries and Dependencies",permalink:"/sc-java-maven-starter-project/docs/developer/libraries-and-dependencies"}},c={},u=[{value:"IDEs",id:"ides",level:2},{value:"Supported IDEs",id:"supported-ides",level:3},{value:"IDE-Specific Configuration",id:"ide-specific-configuration",level:3},{value:"IntelliJ IDEA",id:"intellij-idea",level:4},{value:"Command-Line",id:"command-line",level:2},{value:"Getting Project Name and Version via Maven",id:"getting-project-name-and-version-via-maven",level:2},{value:"Testing with JUnit",id:"testing-with-junit",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Required Java Version",id:"required-java-version",level:3},{value:"Required Maven Version",id:"required-maven-version",level:3},{value:"Required Ewon Firmware Version",id:"required-ewon-firmware-version",level:3},{value:"Contributing",id:"contributing",level:2},{value:"Support Notice",id:"support-notice",level:2}],m={toc:u},v="wrapper";function h(e){let{components:t,...n}=e;return(0,i.kt)(v,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"ides"},"IDEs"),(0,i.kt)("p",null,"This project uses the Maven build system to automatically download libraries and dependencies, and\nto ensure consistent build behavior. As such, this project can be imported into any IDE that\nsupports the Maven build system."),(0,i.kt)("h3",{id:"supported-ides"},"Supported IDEs"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"center"},"IDE"),(0,i.kt)("th",{parentName:"tr",align:"center"},"General Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Launch Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Code Style Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Notes"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://www.eclipse.org/"},"Eclipse Foundation IDE")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.project', '.classpath'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.eclipse/launch-configs/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.eclipse/code-style/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"None")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://www.jetbrains.com/idea/"},"JetBrains IntelliJ IDEA")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/runConfigurations/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/codeStyles/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"The remote debug configuration does not wake the Ewon debug session from the suspend state. Workaround: Update the remote debug configuration to use the 'debugNoSuspend' profile. The Ewon will begin its debug session immediately, therefore, breakpoints at the beginning of the application execution may be missed prior to the IDE debug session connecting.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://code.visualstudio.com"},"Visual Studio Code")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.vscode/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.vscode/tasks.json'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"Not yet supported"),(0,i.kt)("td",{parentName:"tr",align:"center"},"No support has been included for remote debugging of applications on the Ewon. If desired, a remote JVM debugging session will need to be created as described in the ","[Deploy Lifecycle (debug)]"," ( #deploy-lifecycle-debug) section.")))),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"Additional IDEs with support for the Maven build system may be supported by this project, but\nhave not been tested.")),(0,i.kt)("h3",{id:"ide-specific-configuration"},"IDE-Specific Configuration"),(0,i.kt)("h4",{id:"intellij-idea"},"IntelliJ IDEA"),(0,i.kt)("p",null,"When using IntelliJ IDEA with this project, it is recommended to use the following (free) plugins to\nimprove the development experience:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/1065-checkstyle-idea"},"Checkstyle-IDEA")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/8527-google-java-format"},"Google Java Format")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/7642-save-actions"},"Save Actions"))),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"Configuration files for these plugins are already included with this project, and will be\nautomatically detected by IntelliJ IDEA.")),(0,i.kt)("h2",{id:"command-line"},"Command-Line"),(0,i.kt)("p",null,"Maven includes extensive support for the command-line interface (CLI). For more information about\nMaven command-line\ninterface support, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"https://maven.apache.org/run.html"},"https://maven.apache.org/run.html"),"."),(0,i.kt)("h2",{id:"getting-project-name-and-version-via-maven"},"Getting Project Name and Version via Maven"),(0,i.kt)("p",null,"This project includes additional metadata in the JAR file manifest, including the project's name and\nversion\nfrom ",(0,i.kt)("inlineCode",{parentName:"p"},"pom.xml"),"."),(0,i.kt)("p",null,"To alleviate the requirement for including a hardcoded project name or version in source code, you\ncan access those properties as described:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},"class MavenMetadataExample {\n\n String projectName = ExampleClass.class.getPackage().getImplementationTitle();\n String projectVersion = ExampleClass.class.getPackage().getImplementationVersion();\n}\n")),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"The required metadata is only included when the project is packaged via Maven. If you package\nthe project using the ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, the described method of accessing the project name\nand version may not work or could cause an exception.")),(0,i.kt)("h2",{id:"testing-with-junit"},"Testing with JUnit"),(0,i.kt)("p",null,"This project includes basic support for unit testing via the JUnit 3.8.1 test framework. An example\ntest class has been included in this project at ",(0,i.kt)("inlineCode",{parentName:"p"},"src/test/java/ExampleTest.java"),". For detailed\ninformation about JUnit 3.8.1 and its capabilities, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"http://junit.sourceforge.net/junit3.8.1/"},"http://junit.sourceforge.net/junit3.8.1/"),"."),(0,i.kt)("p",null,"For details about the unit testing in this project, refer to\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles#test-lifecycle"},"test lifecycle")," section on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles"},"Maven Lifecycles")," page."),(0,i.kt)("h2",{id:"requirements"},"Requirements"),(0,i.kt)("h3",{id:"required-java-version"},"Required Java Version"),(0,i.kt)(r.ZP,{mdxType:"SysReqJava"}),(0,i.kt)("h3",{id:"required-maven-version"},"Required Maven Version"),(0,i.kt)(o.ZP,{mdxType:"SysReqMaven"}),(0,i.kt)("h3",{id:"required-ewon-firmware-version"},"Required Ewon Firmware Version"),(0,i.kt)(l.ZP,{mdxType:"SysReqEwonFw"}),(0,i.kt)("h2",{id:"contributing"},"Contributing"),(0,i.kt)("p",null,"Detailed information about contributing to this project can be found in\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/contribution-guidelines"},"Contribution Guidelines"),"."),(0,i.kt)("h2",{id:"support-notice"},"Support Notice"),(0,i.kt)("p",null,"While this project is intended to replace the functionality provided by the Ewon JTK's ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml"),"\nAnt build file, the Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file remains the only officially supported\nenvironment for Ewon Java development. For more\ninformation about the official Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"https://developer.ewon.biz/content/java-0"},"https://developer.ewon.biz/content/java-0"),"."),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"This project does not interact with the ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, or the Ant build system.\nTherefore, it is possible to use the official Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file in\nconjunction with the supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"pom.xml")," Maven build file.")))}h.isMDXComponent=!0},9958:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,r.kt)("br",null),(0,r.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,r.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,r.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,r.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}d.isMDXComponent=!0},2919:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("admonition",{type:"note"},(0,r.kt)("p",{parentName:"admonition"},"During the Maven ",(0,r.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,r.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,r.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,r.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,r.kt)(i.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",l().title," CI/CD pipelines.")))}d.isMDXComponent=!0},7712:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,r.kt)("br",null),(0,r.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,r.kt)(i.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",l().title,"\xa0without installing Maven directly."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,r.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/235622ac.96f3d914.js b/assets/js/235622ac.96f3d914.js deleted file mode 100644 index 662c0f6..0000000 --- a/assets/js/235622ac.96f3d914.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[243],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>d,kt:()=>v});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},d=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=p(n),m=i,v=c["".concat(s,".").concat(m)]||c[m]||u[m]||r;return n?a.createElement(v,o(o({ref:t},d),{},{components:n})):a.createElement(v,o({ref:t},d))}));function v(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},8322:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>c,contentTitle:()=>p,default:()=>h,frontMatter:()=>s,metadata:()=>d,toc:()=>u});var a=n(7462),i=(n(7294),n(3905)),r=(n(8979),n(2919)),o=n(7712),l=n(9958);const s={id:"development-environment",title:"Development Environment Information",sidebar_label:"Development Environment Information"},p=void 0,d={unversionedId:"developer/development-environment",id:"developer/development-environment",title:"Development Environment Information",description:"IDEs",source:"@site/docs/08-developer/01-DEVELOPMENT_ENVIRONMENT.mdx",sourceDirName:"08-developer",slug:"/developer/development-environment",permalink:"/sc-java-maven-starter-project/docs/developer/development-environment",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/08-developer/01-DEVELOPMENT_ENVIRONMENT.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"development-environment",title:"Development Environment Information",sidebar_label:"Development Environment Information"},sidebar:"defaultSidebar",previous:{title:"License",permalink:"/sc-java-maven-starter-project/docs/legal/license"},next:{title:"Libraries and Dependencies",permalink:"/sc-java-maven-starter-project/docs/developer/libraries-and-dependencies"}},c={},u=[{value:"IDEs",id:"ides",level:2},{value:"Supported IDEs",id:"supported-ides",level:3},{value:"IDE-Specific Configuration",id:"ide-specific-configuration",level:3},{value:"IntelliJ IDEA",id:"intellij-idea",level:4},{value:"Command-Line",id:"command-line",level:2},{value:"Getting Project Name and Version via Maven",id:"getting-project-name-and-version-via-maven",level:2},{value:"Testing with JUnit",id:"testing-with-junit",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Required Java Version",id:"required-java-version",level:3},{value:"Required Maven Version",id:"required-maven-version",level:3},{value:"Required Ewon Firmware Version",id:"required-ewon-firmware-version",level:3},{value:"Contributing",id:"contributing",level:2},{value:"Support Notice",id:"support-notice",level:2}],m={toc:u},v="wrapper";function h(e){let{components:t,...n}=e;return(0,i.kt)(v,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"ides"},"IDEs"),(0,i.kt)("p",null,"This project uses the Maven build system to automatically download libraries and dependencies, and\nto ensure consistent build behavior. As such, this project can be imported into any IDE that\nsupports the Maven build system."),(0,i.kt)("h3",{id:"supported-ides"},"Supported IDEs"),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:"center"},"IDE"),(0,i.kt)("th",{parentName:"tr",align:"center"},"General Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Launch Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Code Style Config Location(s)"),(0,i.kt)("th",{parentName:"tr",align:"center"},"Notes"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://www.eclipse.org/"},"Eclipse Foundation IDE")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.project', '.classpath'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.eclipse/launch-configs/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.eclipse/code-style/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"None")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://www.jetbrains.com/idea/"},"JetBrains IntelliJ IDEA")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/runConfigurations/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.idea/codeStyles/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"The remote debug configuration does not wake the Ewon debug session from the suspend state. Workaround: Update the remote debug configuration to use the 'debugNoSuspend' profile. The Ewon will begin its debug session immediately, therefore, breakpoints at the beginning of the application execution may be missed prior to the IDE debug session connecting.")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:"center"},(0,i.kt)("a",{parentName:"td",href:"https://code.visualstudio.com"},"Visual Studio Code")),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.vscode/'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"'.vscode/tasks.json'"),(0,i.kt)("td",{parentName:"tr",align:"center"},"Not yet supported"),(0,i.kt)("td",{parentName:"tr",align:"center"},"No support has been included for remote debugging of applications on the Ewon. If desired, a remote JVM debugging session will need to be created as described in the ","[Deploy Lifecycle (debug)]"," ( #deploy-lifecycle-debug) section.")))),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"Additional IDEs with support for the Maven build system may be supported by this project, but\nhave not been tested.")),(0,i.kt)("h3",{id:"ide-specific-configuration"},"IDE-Specific Configuration"),(0,i.kt)("h4",{id:"intellij-idea"},"IntelliJ IDEA"),(0,i.kt)("p",null,"When using IntelliJ IDEA with this project, it is recommended to use the following (free) plugins to\nimprove the development experience:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/1065-checkstyle-idea"},"Checkstyle-IDEA")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/8527-google-java-format"},"Google Java Format")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("a",{parentName:"li",href:"https://plugins.jetbrains.com/plugin/7642-save-actions"},"Save Actions"))),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"Configuration files for these plugins are already included with this project, and will be\nautomatically detected by IntelliJ IDEA.")),(0,i.kt)("h2",{id:"command-line"},"Command-Line"),(0,i.kt)("p",null,"Maven includes extensive support for the command-line interface (CLI). For more information about\nMaven command-line\ninterface support, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"https://maven.apache.org/run.html"},"https://maven.apache.org/run.html"),"."),(0,i.kt)("h2",{id:"getting-project-name-and-version-via-maven"},"Getting Project Name and Version via Maven"),(0,i.kt)("p",null,"This project includes additional metadata in the JAR file manifest, including the project's name and\nversion\nfrom ",(0,i.kt)("inlineCode",{parentName:"p"},"pom.xml"),"."),(0,i.kt)("p",null,"To alleviate the requirement for including a hardcoded project name or version in source code, you\ncan access those properties as described:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-java"},"class MavenMetadataExample {\n\n String projectName = ExampleClass.class.getPackage().getImplementationTitle();\n String projectVersion = ExampleClass.class.getPackage().getImplementationVersion();\n}\n")),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"The required metadata is only included when the project is packaged via Maven. If you package\nthe project using the ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, the described method of accessing the project name\nand version may not work or could cause an exception.")),(0,i.kt)("h2",{id:"testing-with-junit"},"Testing with JUnit"),(0,i.kt)("p",null,"This project includes basic support for unit testing via the JUnit 3.8.1 test framework. An example\ntest class has been included in this project at ",(0,i.kt)("inlineCode",{parentName:"p"},"src/test/java/ExampleTest.java"),". For detailed\ninformation about JUnit 3.8.1 and its capabilities, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"http://junit.sourceforge.net/junit3.8.1/"},"http://junit.sourceforge.net/junit3.8.1/"),"."),(0,i.kt)("p",null,"For details about the unit testing in this project, refer to\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles#test-lifecycle"},"test lifecycle")," section on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles"},"Maven Lifecycles")," page."),(0,i.kt)("h2",{id:"requirements"},"Requirements"),(0,i.kt)("h3",{id:"required-java-version"},"Required Java Version"),(0,i.kt)(r.ZP,{mdxType:"SysReqJava"}),(0,i.kt)("h3",{id:"required-maven-version"},"Required Maven Version"),(0,i.kt)(o.ZP,{mdxType:"SysReqMaven"}),(0,i.kt)("h3",{id:"required-ewon-firmware-version"},"Required Ewon Firmware Version"),(0,i.kt)(l.ZP,{mdxType:"SysReqEwonFw"}),(0,i.kt)("h2",{id:"contributing"},"Contributing"),(0,i.kt)("p",null,"Detailed information about contributing to this project can be found in\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/developer/contribution-guidelines"},"Contribution Guidelines"),"."),(0,i.kt)("h2",{id:"support-notice"},"Support Notice"),(0,i.kt)("p",null,"While this project is intended to replace the functionality provided by the Ewon JTK's ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml"),"\nAnt build file, the Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file remains the only officially supported\nenvironment for Ewon Java development. For more\ninformation about the official Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, please refer\nto ",(0,i.kt)("a",{parentName:"p",href:"https://developer.ewon.biz/content/java-0"},"https://developer.ewon.biz/content/java-0"),"."),(0,i.kt)("admonition",{type:"note"},(0,i.kt)("p",{parentName:"admonition"},"This project does not interact with the ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, or the Ant build system.\nTherefore, it is possible to use the official Ewon-supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file in\nconjunction with the supplied ",(0,i.kt)("inlineCode",{parentName:"p"},"pom.xml")," Maven build file.")))}h.isMDXComponent=!0},9958:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,r.kt)("br",null),(0,r.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,r.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,r.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,r.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}d.isMDXComponent=!0},2919:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("admonition",{type:"note"},(0,r.kt)("p",{parentName:"admonition"},"During the Maven ",(0,r.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,r.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,r.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,r.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,r.kt)(i.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",l().title," CI/CD pipelines.")))}d.isMDXComponent=!0},7712:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},p="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(p,(0,a.Z)({},s,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)(i.Fragment,null,"The ",l().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,r.kt)("br",null),(0,r.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,r.kt)(i.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",l().title,"\xa0without installing Maven directly."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,r.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}d.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9737cf22.bc629773.js b/assets/js/9737cf22.bc629773.js deleted file mode 100644 index 234d447..0000000 --- a/assets/js/9737cf22.bc629773.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[655],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>p,kt:()=>v});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),m=u(n),d=a,v=m["".concat(l,".").concat(d)]||m[d]||c[d]||o;return n?r.createElement(v,i(i({ref:t},p),{},{components:n})):r.createElement(v,i({ref:t},p))}));function v(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:a,i[1]=s;for(var u=2;u{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},5495:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>u,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>c});var r=n(7462),a=(n(7294),n(3905)),o=n(2919),i=n(7712),s=n(9958);const l={id:"system-requirements",title:"System Requirements",sidebar_label:"System Requirements"},u=void 0,p={unversionedId:"usage/system-requirements",id:"usage/system-requirements",title:"System Requirements",description:"Required Java Version",source:"@site/docs/05-usage/02-SYSTEM_REQUIREMENTS.mdx",sourceDirName:"05-usage",slug:"/usage/system-requirements",permalink:"/sc-java-maven-starter-project/docs/usage/system-requirements",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/05-usage/02-SYSTEM_REQUIREMENTS.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"system-requirements",title:"System Requirements",sidebar_label:"System Requirements"},sidebar:"defaultSidebar",previous:{title:"Features",permalink:"/sc-java-maven-starter-project/docs/usage/features"},next:{title:"Frequently Asked Questions",permalink:"/sc-java-maven-starter-project/docs/help/faq"}},m={},c=[{value:"Required Java Version",id:"required-java-version",level:2},{value:"Required Maven Version",id:"required-maven-version",level:2},{value:"Required Ewon Firmware Version",id:"required-ewon-firmware-version",level:2}],d={toc:c},v="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(v,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"required-java-version"},"Required Java Version"),(0,a.kt)(o.ZP,{mdxType:"SysReqJava"}),(0,a.kt)("h2",{id:"required-maven-version"},"Required Maven Version"),(0,a.kt)(i.ZP,{mdxType:"SysReqMaven"}),(0,a.kt)("h2",{id:"required-ewon-firmware-version"},"Required Ewon Firmware Version"),(0,a.kt)(s.ZP,{mdxType:"SysReqEwonFw"}))}f.isMDXComponent=!0},9958:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,o.kt)("br",null),(0,o.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,o.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,o.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,o.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}p.isMDXComponent=!0},2919:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("admonition",{type:"note"},(0,o.kt)("p",{parentName:"admonition"},"During the Maven ",(0,o.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,o.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,o.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,o.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,o.kt)(a.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",s().title," CI/CD pipelines.")))}p.isMDXComponent=!0},7712:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,o.kt)("br",null),(0,o.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,o.kt)(a.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",s().title,"\xa0without installing Maven directly."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,o.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/9737cf22.f4957510.js b/assets/js/9737cf22.f4957510.js new file mode 100644 index 0000000..e778781 --- /dev/null +++ b/assets/js/9737cf22.f4957510.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[655],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>p,kt:()=>v});var r=n(7294);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var l=r.createContext({}),u=function(e){var t=r.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},p=function(e){var t=u(e.components);return r.createElement(l.Provider,{value:t},e.children)},m="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),m=u(n),d=a,v=m["".concat(l,".").concat(d)]||m[d]||c[d]||o;return n?r.createElement(v,i(i({ref:t},p),{},{components:n})):r.createElement(v,i({ref:t},p))}));function v(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[m]="string"==typeof e?e:a,i[1]=s;for(var u=2;u{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},5495:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>u,default:()=>f,frontMatter:()=>l,metadata:()=>p,toc:()=>c});var r=n(7462),a=(n(7294),n(3905)),o=n(2919),i=n(7712),s=n(9958);const l={id:"system-requirements",title:"System Requirements",sidebar_label:"System Requirements"},u=void 0,p={unversionedId:"usage/system-requirements",id:"usage/system-requirements",title:"System Requirements",description:"Required Java Version",source:"@site/docs/05-usage/02-SYSTEM_REQUIREMENTS.mdx",sourceDirName:"05-usage",slug:"/usage/system-requirements",permalink:"/sc-java-maven-starter-project/docs/usage/system-requirements",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/05-usage/02-SYSTEM_REQUIREMENTS.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"system-requirements",title:"System Requirements",sidebar_label:"System Requirements"},sidebar:"defaultSidebar",previous:{title:"Features",permalink:"/sc-java-maven-starter-project/docs/usage/features"},next:{title:"Frequently Asked Questions",permalink:"/sc-java-maven-starter-project/docs/help/faq"}},m={},c=[{value:"Required Java Version",id:"required-java-version",level:2},{value:"Required Maven Version",id:"required-maven-version",level:2},{value:"Required Ewon Firmware Version",id:"required-ewon-firmware-version",level:2}],d={toc:c},v="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(v,(0,r.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"required-java-version"},"Required Java Version"),(0,a.kt)(o.ZP,{mdxType:"SysReqJava"}),(0,a.kt)("h2",{id:"required-maven-version"},"Required Maven Version"),(0,a.kt)(i.ZP,{mdxType:"SysReqMaven"}),(0,a.kt)("h2",{id:"required-ewon-firmware-version"},"Required Ewon Firmware Version"),(0,a.kt)(s.ZP,{mdxType:"SysReqEwonFw"}))}f.isMDXComponent=!0},9958:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,o.kt)("br",null),(0,o.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,o.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,o.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,o.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}p.isMDXComponent=!0},2919:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("admonition",{type:"note"},(0,o.kt)("p",{parentName:"admonition"},"During the Maven ",(0,o.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,o.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,o.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,o.kt)("ul",null,(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,o.kt)("li",{parentName:"ul"},(0,o.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,o.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,o.kt)(a.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",s().title," CI/CD pipelines.")))}p.isMDXComponent=!0},7712:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>p});var r=n(7462),a=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},u="wrapper";function p(e){let{components:t,...n}=e;return(0,o.kt)(u,(0,r.Z)({},l,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,o.kt)("br",null),(0,o.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,o.kt)(a.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",s().title,"\xa0without installing Maven directly."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,o.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/abd378fd.4d7693b1.js b/assets/js/abd378fd.4d7693b1.js new file mode 100644 index 0000000..3bf71dc --- /dev/null +++ b/assets/js/abd378fd.4d7693b1.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[410],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>c,kt:()=>f});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,s=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=p(n),m=i,f=u["".concat(s,".").concat(m)]||u[m]||d[m]||r;return n?a.createElement(f,o(o({ref:t},c),{},{components:n})):a.createElement(f,o({ref:t},c))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:i,o[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},1282:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var a=n(7462),i=(n(7294),n(3905)),r=(n(8979),n(4054)),o=n(8981),l=n(6902);const s={id:"quick-start-guide",title:"Quick Start Guide",sidebar_label:"Quick Start Guide",toc_max_heading_level:2},p=void 0,c={unversionedId:"quick-start-guide",id:"quick-start-guide",title:"Quick Start Guide",description:"Using the Template",source:"@site/docs/03-QUICK_START_GUIDE.mdx",sourceDirName:".",slug:"/quick-start-guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/03-QUICK_START_GUIDE.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{id:"quick-start-guide",title:"Quick Start Guide",sidebar_label:"Quick Start Guide",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Change Log",permalink:"/sc-java-maven-starter-project/docs/change-log"},next:{title:"Using Template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template"}},u={},d=[{value:"Using the Template",id:"using-the-template",level:2},{value:"NOTE",id:"note",level:3},{value:"Configuring the Maven POM File",id:"configuring-the-maven-pom-file",level:2},{value:"NOTE",id:"note-1",level:3},{value:"Configuring the Documentation",id:"configuring-the-documentation",level:2},{value:"NOTE",id:"note-2",level:3}],m={toc:d},f="wrapper";function h(e){let{components:t,...n}=e;return(0,i.kt)(f,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"using-the-template"},"Using the Template"),(0,i.kt)(r.ZP,{mdxType:"UseTemplateGitHubPartial"}),(0,i.kt)("h3",{id:"note"},"NOTE"),(0,i.kt)("p",null,"Additional information and alternative method(s) for using the template can be found on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/using-template"},"Using Template")," page."),(0,i.kt)("h2",{id:"configuring-the-maven-pom-file"},"Configuring the Maven POM File"),(0,i.kt)(o.ZP,{mdxType:"ConfiguringMavenPomFilePartial"}),(0,i.kt)("h3",{id:"note-1"},"NOTE"),(0,i.kt)("p",null,"Additional information about the Maven POM file and its configuration can be found on the\n",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/configuration"},"Configuration")," page."),(0,i.kt)("h2",{id:"configuring-the-documentation"},"Configuring the Documentation"),(0,i.kt)(l.ZP,{mdxType:"ConfiguringDocusaurusPartial"}),(0,i.kt)("h3",{id:"note-2"},"NOTE"),(0,i.kt)("p",null,"Additional information about the Docusaurus configuration file and its fields can be found on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/configuration"},"Configuration")," page."))}h.isMDXComponent=!0},6902:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o),s=n(4976),p=n(7873);const c={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"File Location: ",(0,r.kt)("inlineCode",{parentName:"em"},"web-docs/ScDocusaurusConfig.js"))),(0,r.kt)("p",null,"The documentation configuration file is used to configure the documentation's title, description,\nand GitHub repository information, and must be updated before the documentation can be built."),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"Open the documentation configuration file located at ",(0,r.kt)("inlineCode",{parentName:"p"},"web-docs/ScDocusaurusConfig.js")," in your\nfavorite text editor."),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"Update the values of the following fields within the documentation configuration\nfile: ",(0,r.kt)("inlineCode",{parentName:"p"},"repoOwnerName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"repoName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", and ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),"."),(0,r.kt)("img",{src:s.Z,alt:"Docusaurus config file fields highlighted"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)(i.Fragment,null,"After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the ",l().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}d.isMDXComponent=!0},8981:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o),s=n(9776),p=n(7873);const c={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"File Location: ",(0,r.kt)("inlineCode",{parentName:"em"},"pom.xml"))),(0,r.kt)("p",null,"The Maven POM file is used to configure the project's dependencies, build process, and\nother project settings. This includes the project's name, version, description, and main class,\nwhich must be configured before the project can be built."),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"Open the Maven POM file located at ",(0,r.kt)("inlineCode",{parentName:"p"},"pom.xml")," in your favorite text editor."),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"Update the values of the following fields within the Maven POM\nFile: ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"version"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"artifactId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"project.main.class"),"."),(0,r.kt)("img",{src:s.Z,alt:"Maven pom file fields highlighted"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)(i.Fragment,null,"After saving the changes to the Maven POM file, the project can be built, and you may continue setting up and using the ",l().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}d.isMDXComponent=!0},4054:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>f});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),l=n.n(o);const s="data:image/webp;base64,UklGRjIGAABXRUJQVlA4TCUGAAAvrUASABrK8v+nkaNXaAgnJ7wxn5iTB+DkHZbhyHDfGymMPi1D0LPUFYauOAw924HuGp6xa1xWtSR7NN1aLUPHy8yMYeZ/6r8sx9o2tW5WcNHMzPZnZoaANuAV3E5laLrwVOqUipmT6ZTKGFZnZlVmq8qExqFPrrb9h+achW3bxhvbmgPYE5gq1q8LpwqnCtecKl8Va6os/9XHNf/Rf4O3/w7cSHKUqrsjQ5FhnhCNxL8JsGMqau7q3D1z6Pic4RP6sQgoua9jegbM7D00tWXnlMZtBNCPl76d2Xf4rs7d70oBM7r2E0BXzug+cFfnbpkV/yaAvvwbZXantu4igL58X2anOKVpOwH05ZGiBD+CzvzxlWwI7jk+HfrEgXg56fZyRcogUeDXRGCVOiu2mTBuAvIpgUcDltODvFt4LKFcvZLwAX4I7DJlXAYfVwhMSrkrrg7ymkbYADw/LxaetKMptYhMEavJIyxfSQxI5pn2DCnpcs6cAAGesQJ2YNCjyeghYoMnnUDEXM6Jb9ZOTHghsZa+4YA/LgTdKXfO00SPeu0chFhEfM+XyIqSE+oDDBfYQ/YqsZ5zy95ZkIBPNdO65xL+m97pucghuJFRKx/gvzt37hELYv4C9FT5GrFKf/hQuKtPX7mVWZ4RPFVgdooV3LHjmsIt8+YSPhbAcwPanHjumexw56jhzvAGT1owLnsfaEq9dk4WC/vACaylWq7cjNKU3BkKZz1U7rEwpZN+trJpFQBAYC1OSeUEKefMCVkgun2J7NGsNB+W33xS+c6ga1asVXezG/yykgGSQg6PunRnaLk7VOkb3BTYnB+r5iaWK3lODNlzpNSfCPmGdc/26XJu+YQk5cR3WdNDLAQtp6DwPGDjpGGhVGrKlZJ3IACB1L6jTZ9IAIDvADvf43hNd/iej0cvWic/50XCAX/iCXYDqzBBDfeaJ0Dg7M/F58hy6ADLLKPnP7AJQdwUQMi3EMTkqgWQfUD/y/aU3Jpfjv1uwCnzNCUxo4cMgRPIFd49AUezV78Awdn0gznPEKvMhwdcAIBY409kDeyVl9b3WAyD3QDP5KUGJPVA2TvGNUQf7wiNAW+yU1JrfiCwqybInhEowQcaMsseAHgAN/Y+07h1xy6V+lzinZhCfvnl0gEAkADAgL3DmaOGe4wr5AobX2JDfCDcC166xzWU2lp1TXFpcyro31Aaa1VYoynOknFAY8zTt5KVCn7pciW1Gkh5yg3J7kjKCX5uCvk/RwL+dzVm4m9TuGk1Z81BSDqDqZ0nm595vwdiYeKCKSUp1XciZYqU2lp9ssnr8ScGw47eHLjLhVczZyjNyjmwUtaWXHW+sVfJ4PmPS88N6DC4ZsIxhbPjptoR3IPGmR8IrM1SOSERbRNc++4swGYR9DTx8/ROD7EBa23f2SHLSHgQkhZgyFkl1vJDMCvhu5ro0ZTpgCEhJC2zPrg7xCyHfIkNktGva+eIn29YlQO89Of6HWI9g6mJOYaQzz630OHK+jkbGuUL8huf30rhVJYryhv75JT2yy27vrJJtkhP/Lpk9v3Db1+dkS3SE02Tee7fv87xVqus4nsaOkFBlaVJMo+SeAZUVAZF/r2qypFiw6sqkwHOkLyKEfkVN1W13lLdemt1Kyil1GRAlakLZ97LkZlP+r8bPHR4wMDBycU1B1Q6QmrqwnZmdB8ggAJyEM/U/fq1azvWPr3w6NGJxbWgipITLTYtnDVwdFrH3sJfQKRtUTXimervP57fm2+bUQBqOKV5x4mTktPCUIlJbAD8iB/VkE9i1ZUdcxmxb/tOkVBzRiNxIecgYsXXTcRFU2+0RyyaEk9kXo7F0v9h+NQeX/z12Y3ievP0Qo0Sj2eVvP+EeLxXyzZ9Eo0ld6pt3XO4hPibPgljsbTR1mnneAsDfTeeyAs1ZyyefvWZS8Hs2o7FEzmh7ozHM6Y97Alk3suRWDwj1J2xSGKbnLINayqIESdPRKNJofaMRVOPfuZf77v99I9Qg/7Rvalr1dw3YZ/79+8d8m4xGk0MdWg0mtImp2z/s5+/JJdnlsy+v/vG44sfRSMJoR6NROKPnY3Hs2PxrHgs/ffwtTMCAA==";var p=n(347),c=n(3221),u=n(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3},{value:"Step 4",id:"step-4",level:3}]},m="wrapper";function f(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,'The easiest way to use this template is to use GitHub\'s "Use this template" option. This will\nautomatically create a new repository from the template and allow you to clone the repository to\nyour local machine.'),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Use this template'\nbutton on the ",(0,r.kt)("a",{href:l().repoUrl},"GitHub repository page"),"."),(0,r.kt)("img",{src:s,alt:"Use this template button",width:"200"}),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"After the 'New repository' page has loaded, follow the steps requested to create a new repository\nfrom the template and submit."),(0,r.kt)("img",{src:p.Z,alt:"New repository from template page",width:"400"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)("p",null,"Once the new repository is created, you may clone the repository to your local machine using the\npreferred Git Client of your choice.",(0,r.kt)("br",null),(0,r.kt)("br",null)),(0,r.kt)("img",{src:c.Z,alt:"GitHub code button menu",width:"400"}),(0,r.kt)("h3",{id:"step-4"},"Step 4"),(0,r.kt)(i.Fragment,null,"Once the new repository has been cloned, you may continue with setting up and using the\xa0",l().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}f.isMDXComponent=!0},4976:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/docusaurus-update-project-info-93b51f9b35aa9d7270a537d66ff853f5.webp"},3221:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-code-btn-menu-e320f01043ae039105bb6b6b6260b5f2.webp"},347:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-template-repo-setup-823e2db89e15f53a89643c0c7d5ba216.webp"},7873:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"},9776:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/pom-update-project-info-1598b2441cec71969f0e3e1829f2ffb9.webp"}}]); \ No newline at end of file diff --git a/assets/js/abd378fd.e7ad7947.js b/assets/js/abd378fd.e7ad7947.js deleted file mode 100644 index 79a9909..0000000 --- a/assets/js/abd378fd.e7ad7947.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[410],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>c,kt:()=>f});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},m=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(n),m=i,f=u["".concat(l,".").concat(m)]||u[m]||d[m]||r;return n?a.createElement(f,o(o({ref:t},c),{},{components:n})):a.createElement(f,o({ref:t},c))}));function f(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,o=new Array(r);o[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:i,o[1]=s;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},1282:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>h,frontMatter:()=>l,metadata:()=>c,toc:()=>d});var a=n(7462),i=(n(7294),n(3905)),r=(n(8979),n(4054)),o=n(8981),s=n(6902);const l={id:"quick-start-guide",title:"Quick Start Guide",sidebar_label:"Quick Start Guide",toc_max_heading_level:2},p=void 0,c={unversionedId:"quick-start-guide",id:"quick-start-guide",title:"Quick Start Guide",description:"Using the Template",source:"@site/docs/03-QUICK_START_GUIDE.mdx",sourceDirName:".",slug:"/quick-start-guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/03-QUICK_START_GUIDE.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{id:"quick-start-guide",title:"Quick Start Guide",sidebar_label:"Quick Start Guide",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Change Log",permalink:"/sc-java-maven-starter-project/docs/change-log"},next:{title:"Using Template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template"}},u={},d=[{value:"Using the Template",id:"using-the-template",level:2},{value:"NOTE",id:"note",level:3},{value:"Configuring the Maven POM File",id:"configuring-the-maven-pom-file",level:2},{value:"NOTE",id:"note-1",level:3},{value:"Configuring the Documentation",id:"configuring-the-documentation",level:2},{value:"NOTE",id:"note-2",level:3}],m={toc:d},f="wrapper";function h(e){let{components:t,...n}=e;return(0,i.kt)(f,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("h2",{id:"using-the-template"},"Using the Template"),(0,i.kt)(r.ZP,{mdxType:"UseTemplateGitHubPartial"}),(0,i.kt)("h3",{id:"note"},"NOTE"),(0,i.kt)("p",null,"Additional information and alternative method(s) for using the template can be found on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/using-template"},"Using Template")," page."),(0,i.kt)("h2",{id:"configuring-the-maven-pom-file"},"Configuring the Maven POM File"),(0,i.kt)(o.ZP,{mdxType:"ConfiguringMavenPomFilePartial"}),(0,i.kt)("h3",{id:"note-1"},"NOTE"),(0,i.kt)("p",null,"Additional information about the Maven POM file and its configuration can be found on the\n",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/configuration"},"Configuration")," page."),(0,i.kt)("h2",{id:"configuring-the-documentation"},"Configuring the Documentation"),(0,i.kt)(s.ZP,{mdxType:"ConfiguringDocusaurusPartial"}),(0,i.kt)("h3",{id:"note-2"},"NOTE"),(0,i.kt)("p",null,"Additional information about the Docusaurus configuration file and its fields can be found on\nthe ",(0,i.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/setup/configuration"},"Configuration")," page."))}h.isMDXComponent=!0},6902:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),s=n.n(o),l=n(4976),p=n(7873);const c={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"File Location: ",(0,r.kt)("inlineCode",{parentName:"em"},"web-docs/ScDocusaurusConfig.js"))),(0,r.kt)("p",null,"The documentation configuration file is used to configure the documentation's title, description,\nand GitHub repository information, and must be updated before the documentation can be built."),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"Open the documentation configuration file located at ",(0,r.kt)("inlineCode",{parentName:"p"},"web-docs/ScDocusaurusConfig.js")," in your\nfavorite text editor."),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"Update the values of the following fields within the documentation configuration\nfile: ",(0,r.kt)("inlineCode",{parentName:"p"},"repoOwnerName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"repoName"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"description"),", and ",(0,r.kt)("inlineCode",{parentName:"p"},"meta"),"."),(0,r.kt)("img",{src:l.Z,alt:"Docusaurus config file fields highlighted"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)(i.Fragment,null,"After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the ",s().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}d.isMDXComponent=!0},8981:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>d});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),s=n.n(o),l=n(9776),p=n(7873);const c={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function d(e){let{components:t,...n}=e;return(0,r.kt)(u,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"File Location: ",(0,r.kt)("inlineCode",{parentName:"em"},"pom.xml"))),(0,r.kt)("p",null,"The Maven POM file is used to configure the project's dependencies, build process, and\nother project settings. This includes the project's name, version, description, and main class,\nwhich must be configured before the project can be built."),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"Open the Maven POM file located at ",(0,r.kt)("inlineCode",{parentName:"p"},"pom.xml")," in your favorite text editor."),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"Update the values of the following fields within the Maven POM\nFile: ",(0,r.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"version"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"artifactId"),", ",(0,r.kt)("inlineCode",{parentName:"p"},"project.main.class"),"."),(0,r.kt)("img",{src:l.Z,alt:"Maven pom file fields highlighted"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)(i.Fragment,null,"After saving the changes to the Maven POM file, the project can be built, and you may continue setting up and using the ",s().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}d.isMDXComponent=!0},4054:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>f});var a=n(7462),i=n(7294),r=n(3905),o=n(8979),s=n.n(o);const l="data:image/webp;base64,UklGRjIGAABXRUJQVlA4TCUGAAAvrUASABrK8v+nkaNXaAgnJ7wxn5iTB+DkHZbhyHDfGymMPi1D0LPUFYauOAw924HuGp6xa1xWtSR7NN1aLUPHy8yMYeZ/6r8sx9o2tW5WcNHMzPZnZoaANuAV3E5laLrwVOqUipmT6ZTKGFZnZlVmq8qExqFPrrb9h+achW3bxhvbmgPYE5gq1q8LpwqnCtecKl8Va6os/9XHNf/Rf4O3/w7cSHKUqrsjQ5FhnhCNxL8JsGMqau7q3D1z6Pic4RP6sQgoua9jegbM7D00tWXnlMZtBNCPl76d2Xf4rs7d70oBM7r2E0BXzug+cFfnbpkV/yaAvvwbZXantu4igL58X2anOKVpOwH05ZGiBD+CzvzxlWwI7jk+HfrEgXg56fZyRcogUeDXRGCVOiu2mTBuAvIpgUcDltODvFt4LKFcvZLwAX4I7DJlXAYfVwhMSrkrrg7ymkbYADw/LxaetKMptYhMEavJIyxfSQxI5pn2DCnpcs6cAAGesQJ2YNCjyeghYoMnnUDEXM6Jb9ZOTHghsZa+4YA/LgTdKXfO00SPeu0chFhEfM+XyIqSE+oDDBfYQ/YqsZ5zy95ZkIBPNdO65xL+m97pucghuJFRKx/gvzt37hELYv4C9FT5GrFKf/hQuKtPX7mVWZ4RPFVgdooV3LHjmsIt8+YSPhbAcwPanHjumexw56jhzvAGT1owLnsfaEq9dk4WC/vACaylWq7cjNKU3BkKZz1U7rEwpZN+trJpFQBAYC1OSeUEKefMCVkgun2J7NGsNB+W33xS+c6ga1asVXezG/yykgGSQg6PunRnaLk7VOkb3BTYnB+r5iaWK3lODNlzpNSfCPmGdc/26XJu+YQk5cR3WdNDLAQtp6DwPGDjpGGhVGrKlZJ3IACB1L6jTZ9IAIDvADvf43hNd/iej0cvWic/50XCAX/iCXYDqzBBDfeaJ0Dg7M/F58hy6ADLLKPnP7AJQdwUQMi3EMTkqgWQfUD/y/aU3Jpfjv1uwCnzNCUxo4cMgRPIFd49AUezV78Awdn0gznPEKvMhwdcAIBY409kDeyVl9b3WAyD3QDP5KUGJPVA2TvGNUQf7wiNAW+yU1JrfiCwqybInhEowQcaMsseAHgAN/Y+07h1xy6V+lzinZhCfvnl0gEAkADAgL3DmaOGe4wr5AobX2JDfCDcC166xzWU2lp1TXFpcyro31Aaa1VYoynOknFAY8zTt5KVCn7pciW1Gkh5yg3J7kjKCX5uCvk/RwL+dzVm4m9TuGk1Z81BSDqDqZ0nm595vwdiYeKCKSUp1XciZYqU2lp9ssnr8ScGw47eHLjLhVczZyjNyjmwUtaWXHW+sVfJ4PmPS88N6DC4ZsIxhbPjptoR3IPGmR8IrM1SOSERbRNc++4swGYR9DTx8/ROD7EBa23f2SHLSHgQkhZgyFkl1vJDMCvhu5ro0ZTpgCEhJC2zPrg7xCyHfIkNktGva+eIn29YlQO89Of6HWI9g6mJOYaQzz630OHK+jkbGuUL8huf30rhVJYryhv75JT2yy27vrJJtkhP/Lpk9v3Db1+dkS3SE02Tee7fv87xVqus4nsaOkFBlaVJMo+SeAZUVAZF/r2qypFiw6sqkwHOkLyKEfkVN1W13lLdemt1Kyil1GRAlakLZ97LkZlP+r8bPHR4wMDBycU1B1Q6QmrqwnZmdB8ggAJyEM/U/fq1azvWPr3w6NGJxbWgipITLTYtnDVwdFrH3sJfQKRtUTXimervP57fm2+bUQBqOKV5x4mTktPCUIlJbAD8iB/VkE9i1ZUdcxmxb/tOkVBzRiNxIecgYsXXTcRFU2+0RyyaEk9kXo7F0v9h+NQeX/z12Y3ievP0Qo0Sj2eVvP+EeLxXyzZ9Eo0ld6pt3XO4hPibPgljsbTR1mnneAsDfTeeyAs1ZyyefvWZS8Hs2o7FEzmh7ozHM6Y97Alk3suRWDwj1J2xSGKbnLINayqIESdPRKNJofaMRVOPfuZf77v99I9Qg/7Rvalr1dw3YZ/79+8d8m4xGk0MdWg0mtImp2z/s5+/JJdnlsy+v/vG44sfRSMJoR6NROKPnY3Hs2PxrHgs/ffwtTMCAA==";var p=n(347),c=n(3221),u=n(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3},{value:"Step 4",id:"step-4",level:3}]},m="wrapper";function f(e){let{components:t,...n}=e;return(0,r.kt)(m,(0,a.Z)({},d,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,'The easiest way to use this template is to use GitHub\'s "Use this template" option. This will\nautomatically create a new repository from the template and allow you to clone the repository to\nyour local machine.'),(0,r.kt)("h3",{id:"step-1"},"Step 1"),(0,r.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Use this template'\nbutton on the ",(0,r.kt)("a",{href:s().repoUrl},"GitHub repository page"),"."),(0,r.kt)("img",{src:l,alt:"Use this template button",width:"200"}),(0,r.kt)("h3",{id:"step-2"},"Step 2"),(0,r.kt)("p",null,"After the 'New repository' page has loaded, follow the steps requested to create a new repository\nfrom the template and submit."),(0,r.kt)("img",{src:p.Z,alt:"New repository from template page",width:"400"}),(0,r.kt)("h3",{id:"step-3"},"Step 3"),(0,r.kt)("p",null,"Once the new repository is created, you may clone the repository to your local machine using the\npreferred Git Client of your choice.",(0,r.kt)("br",null),(0,r.kt)("br",null)),(0,r.kt)("img",{src:c.Z,alt:"GitHub code button menu",width:"400"}),(0,r.kt)("h3",{id:"step-4"},"Step 4"),(0,r.kt)(i.Fragment,null,"Once the new repository has been cloned, you may continue with setting up and using the\xa0",s().title,"."),(0,r.kt)("br",null),(0,r.kt)("br",null),(0,r.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}f.isMDXComponent=!0},4976:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/docusaurus-update-project-info-93b51f9b35aa9d7270a537d66ff853f5.webp"},3221:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-code-btn-menu-e320f01043ae039105bb6b6b6260b5f2.webp"},347:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-template-repo-setup-823e2db89e15f53a89643c0c7d5ba216.webp"},7873:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"},9776:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/pom-update-project-info-1598b2441cec71969f0e3e1829f2ffb9.webp"}}]); \ No newline at end of file diff --git a/assets/js/b19c86cd.d5976f25.js b/assets/js/b19c86cd.d5976f25.js new file mode 100644 index 0000000..77943a0 --- /dev/null +++ b/assets/js/b19c86cd.d5976f25.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[631],{3905:(e,t,a)=>{"use strict";a.d(t,{Zo:()=>c,kt:()=>h});var r=a(7294);function n(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function o(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,r)}return a}function i(e){for(var t=1;t=0||(n[a]=e[a]);return n}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(n[a]=e[a])}return n}var l=r.createContext({}),p=function(e){var t=r.useContext(l),a=t;return e&&(a="function"==typeof e?e(t):i(i({},t),e)),a},c=function(e){var t=p(e.components);return r.createElement(l.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},d=r.forwardRef((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(a),d=n,h=u["".concat(l,".").concat(d)]||u[d]||m[d]||o;return a?r.createElement(h,i(i({ref:t},c),{},{components:a})):r.createElement(h,i({ref:t},c))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:n,i[1]=s;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},2856:(e,t,a)=>{"use strict";a.r(t),a.d(t,{assets:()=>f,contentTitle:()=>d,default:()=>w,frontMatter:()=>m,metadata:()=>h,toc:()=>g});var r=a(7462),n=a(7294),o=a(3905),i=a(8979),s=a.n(i),l=a(4054);a(347),a(3221);const p=a.p+"assets/images/github-code-btn-download-zip-444e965f89af4ffea5578ae9e67a2a4d.webp",c=a.p+"assets/images/github-download-zip-extract-9a68a6979b4173c045c810e84c4bf14b.webp";var u=a(7873);const m={id:"using-template",title:"Using Template",sidebar_label:"Using Template",toc_max_heading_level:2},d=void 0,h={unversionedId:"setup/using-template",id:"setup/using-template",title:"Using Template",description:"There are two ways to use the {ScDocusaurusConfig.title} as a template when creating a new",source:"@site/docs/04-setup/01-USING_TEMPLATE.mdx",sourceDirName:"04-setup",slug:"/setup/using-template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/04-setup/01-USING_TEMPLATE.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"using-template",title:"Using Template",sidebar_label:"Using Template",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Quick Start Guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide"},next:{title:"Configuration",permalink:"/sc-java-maven-starter-project/docs/setup/configuration"}},f={},g=[{value:"A. GitHub's "Use this template" Option",id:"a-githubs-use-this-template-option",level:2},{value:"B. Manual Download",id:"b-manual-download",level:2},{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}],y={toc:g},b="wrapper";function w(e){let{components:t,...a}=e;return(0,o.kt)(b,(0,r.Z)({},y,a,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(n.Fragment,null,"There are two ways to use the ",s().title," as a template when creating a new project or rebasing an existing one."),(0,o.kt)("br",null),(0,o.kt)("h2",{id:"a-githubs-use-this-template-option"},'A. GitHub\'s "Use this template" Option'),(0,o.kt)(l.ZP,{mdxType:"UseTemplateGitHubPartial"}),(0,o.kt)("h2",{id:"b-manual-download"},"B. Manual Download"),(0,o.kt)("p",null,'If you do not wish to use GitHub\'s "Use this template" option, you may manually download the\ntemplate and take advantage of its features.'),(0,o.kt)("h3",{id:"step-1"},"Step 1"),(0,o.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Download ZIP'\noption under the 'Code' button on the ",(0,o.kt)("a",{href:s().repoUrl},"GitHub repository\npage"),"."),(0,o.kt)("p",null,"Alternatively, you may download the template from the ",(0,o.kt)("a",{href:s().repoArchiveUrl},"\nGitHub repository archive"),"."),(0,o.kt)("img",{src:p,alt:"GitHub code button menu download zip option",width:"400"}),(0,o.kt)("h3",{id:"step-2"},"Step 2"),(0,o.kt)("p",null,"After the ZIP file has downloaded, extract the contents to a new directory on your local machine."),(0,o.kt)("p",null,"If you wish to use the template as a new repository, you may create a new repository from the\nextracted contents. Otherwise, you may copy the contents to an existing repository."),(0,o.kt)("img",{src:c,alt:"GitHub downloaded zip extraction",width:"400"}),(0,o.kt)("h3",{id:"step-3"},"Step 3"),(0,o.kt)(n.Fragment,null,"Once the downloaded ZIP file has been extracted, you may begin using the\xa0",s().title,".")," Additional documentation may be found in the menu to the left (above on mobile).",(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}w.isMDXComponent=!0},4054:(e,t,a)=>{"use strict";a.d(t,{ZP:()=>h});var r=a(7462),n=a(7294),o=a(3905),i=a(8979),s=a.n(i);const l="data:image/webp;base64,UklGRjIGAABXRUJQVlA4TCUGAAAvrUASABrK8v+nkaNXaAgnJ7wxn5iTB+DkHZbhyHDfGymMPi1D0LPUFYauOAw924HuGp6xa1xWtSR7NN1aLUPHy8yMYeZ/6r8sx9o2tW5WcNHMzPZnZoaANuAV3E5laLrwVOqUipmT6ZTKGFZnZlVmq8qExqFPrrb9h+achW3bxhvbmgPYE5gq1q8LpwqnCtecKl8Va6os/9XHNf/Rf4O3/w7cSHKUqrsjQ5FhnhCNxL8JsGMqau7q3D1z6Pic4RP6sQgoua9jegbM7D00tWXnlMZtBNCPl76d2Xf4rs7d70oBM7r2E0BXzug+cFfnbpkV/yaAvvwbZXantu4igL58X2anOKVpOwH05ZGiBD+CzvzxlWwI7jk+HfrEgXg56fZyRcogUeDXRGCVOiu2mTBuAvIpgUcDltODvFt4LKFcvZLwAX4I7DJlXAYfVwhMSrkrrg7ymkbYADw/LxaetKMptYhMEavJIyxfSQxI5pn2DCnpcs6cAAGesQJ2YNCjyeghYoMnnUDEXM6Jb9ZOTHghsZa+4YA/LgTdKXfO00SPeu0chFhEfM+XyIqSE+oDDBfYQ/YqsZ5zy95ZkIBPNdO65xL+m97pucghuJFRKx/gvzt37hELYv4C9FT5GrFKf/hQuKtPX7mVWZ4RPFVgdooV3LHjmsIt8+YSPhbAcwPanHjumexw56jhzvAGT1owLnsfaEq9dk4WC/vACaylWq7cjNKU3BkKZz1U7rEwpZN+trJpFQBAYC1OSeUEKefMCVkgun2J7NGsNB+W33xS+c6ga1asVXezG/yykgGSQg6PunRnaLk7VOkb3BTYnB+r5iaWK3lODNlzpNSfCPmGdc/26XJu+YQk5cR3WdNDLAQtp6DwPGDjpGGhVGrKlZJ3IACB1L6jTZ9IAIDvADvf43hNd/iej0cvWic/50XCAX/iCXYDqzBBDfeaJ0Dg7M/F58hy6ADLLKPnP7AJQdwUQMi3EMTkqgWQfUD/y/aU3Jpfjv1uwCnzNCUxo4cMgRPIFd49AUezV78Awdn0gznPEKvMhwdcAIBY409kDeyVl9b3WAyD3QDP5KUGJPVA2TvGNUQf7wiNAW+yU1JrfiCwqybInhEowQcaMsseAHgAN/Y+07h1xy6V+lzinZhCfvnl0gEAkADAgL3DmaOGe4wr5AobX2JDfCDcC166xzWU2lp1TXFpcyro31Aaa1VYoynOknFAY8zTt5KVCn7pciW1Gkh5yg3J7kjKCX5uCvk/RwL+dzVm4m9TuGk1Z81BSDqDqZ0nm595vwdiYeKCKSUp1XciZYqU2lp9ssnr8ScGw47eHLjLhVczZyjNyjmwUtaWXHW+sVfJ4PmPS88N6DC4ZsIxhbPjptoR3IPGmR8IrM1SOSERbRNc++4swGYR9DTx8/ROD7EBa23f2SHLSHgQkhZgyFkl1vJDMCvhu5ro0ZTpgCEhJC2zPrg7xCyHfIkNktGva+eIn29YlQO89Of6HWI9g6mJOYaQzz630OHK+jkbGuUL8huf30rhVJYryhv75JT2yy27vrJJtkhP/Lpk9v3Db1+dkS3SE02Tee7fv87xVqus4nsaOkFBlaVJMo+SeAZUVAZF/r2qypFiw6sqkwHOkLyKEfkVN1W13lLdemt1Kyil1GRAlakLZ97LkZlP+r8bPHR4wMDBycU1B1Q6QmrqwnZmdB8ggAJyEM/U/fq1azvWPr3w6NGJxbWgipITLTYtnDVwdFrH3sJfQKRtUTXimervP57fm2+bUQBqOKV5x4mTktPCUIlJbAD8iB/VkE9i1ZUdcxmxb/tOkVBzRiNxIecgYsXXTcRFU2+0RyyaEk9kXo7F0v9h+NQeX/z12Y3ievP0Qo0Sj2eVvP+EeLxXyzZ9Eo0ld6pt3XO4hPibPgljsbTR1mnneAsDfTeeyAs1ZyyefvWZS8Hs2o7FEzmh7ozHM6Y97Alk3suRWDwj1J2xSGKbnLINayqIESdPRKNJofaMRVOPfuZf77v99I9Qg/7Rvalr1dw3YZ/79+8d8m4xGk0MdWg0mtImp2z/s5+/JJdnlsy+v/vG44sfRSMJoR6NROKPnY3Hs2PxrHgs/ffwtTMCAA==";var p=a(347),c=a(3221),u=a(7873);const m={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3},{value:"Step 4",id:"step-4",level:3}]},d="wrapper";function h(e){let{components:t,...a}=e;return(0,o.kt)(d,(0,r.Z)({},m,a,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,'The easiest way to use this template is to use GitHub\'s "Use this template" option. This will\nautomatically create a new repository from the template and allow you to clone the repository to\nyour local machine.'),(0,o.kt)("h3",{id:"step-1"},"Step 1"),(0,o.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Use this template'\nbutton on the ",(0,o.kt)("a",{href:s().repoUrl},"GitHub repository page"),"."),(0,o.kt)("img",{src:l,alt:"Use this template button",width:"200"}),(0,o.kt)("h3",{id:"step-2"},"Step 2"),(0,o.kt)("p",null,"After the 'New repository' page has loaded, follow the steps requested to create a new repository\nfrom the template and submit."),(0,o.kt)("img",{src:p.Z,alt:"New repository from template page",width:"400"}),(0,o.kt)("h3",{id:"step-3"},"Step 3"),(0,o.kt)("p",null,"Once the new repository is created, you may clone the repository to your local machine using the\npreferred Git Client of your choice.",(0,o.kt)("br",null),(0,o.kt)("br",null)),(0,o.kt)("img",{src:c.Z,alt:"GitHub code button menu",width:"400"}),(0,o.kt)("h3",{id:"step-4"},"Step 4"),(0,o.kt)(n.Fragment,null,"Once the new repository has been cloned, you may continue with setting up and using the\xa0",s().title,"."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}h.isMDXComponent=!0},3221:(e,t,a)=>{"use strict";a.d(t,{Z:()=>r});const r=a.p+"assets/images/github-code-btn-menu-e320f01043ae039105bb6b6b6260b5f2.webp"},347:(e,t,a)=>{"use strict";a.d(t,{Z:()=>r});const r=a.p+"assets/images/github-template-repo-setup-823e2db89e15f53a89643c0c7d5ba216.webp"},7873:(e,t,a)=>{"use strict";a.d(t,{Z:()=>r});const r=a.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"}}]); \ No newline at end of file diff --git a/assets/js/b19c86cd.f9186e5a.js b/assets/js/b19c86cd.f9186e5a.js deleted file mode 100644 index eb5123a..0000000 --- a/assets/js/b19c86cd.f9186e5a.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[631],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>c,kt:()=>h});var a=n(7294);function r(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function o(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function i(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var l=a.createContext({}),p=function(e){var t=a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},c=function(e){var t=p(e.components);return a.createElement(l.Provider,{value:t},e.children)},u="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,l=e.parentName,c=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=r,h=u["".concat(l,".").concat(d)]||u[d]||m[d]||o;return n?a.createElement(h,i(i({ref:t},c),{},{components:n})):a.createElement(h,i({ref:t},c))}));function h(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:r,i[1]=s;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},2856:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>f,contentTitle:()=>d,default:()=>w,frontMatter:()=>m,metadata:()=>h,toc:()=>g});var a=n(7462),r=n(7294),o=n(3905),i=n(8979),s=n.n(i),l=n(4054);n(347),n(3221);const p=n.p+"assets/images/github-code-btn-download-zip-444e965f89af4ffea5578ae9e67a2a4d.webp",c=n.p+"assets/images/github-download-zip-extract-9a68a6979b4173c045c810e84c4bf14b.webp";var u=n(7873);const m={id:"using-template",title:"Using Template",sidebar_label:"Using Template",toc_max_heading_level:2},d=void 0,h={unversionedId:"setup/using-template",id:"setup/using-template",title:"Using Template",description:"There are two ways to use the {ScDocusaurusConfig.title} as a template when creating a new",source:"@site/docs/04-setup/01-USING_TEMPLATE.mdx",sourceDirName:"04-setup",slug:"/setup/using-template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/04-setup/01-USING_TEMPLATE.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"using-template",title:"Using Template",sidebar_label:"Using Template",toc_max_heading_level:2},sidebar:"defaultSidebar",previous:{title:"Quick Start Guide",permalink:"/sc-java-maven-starter-project/docs/quick-start-guide"},next:{title:"Configuration",permalink:"/sc-java-maven-starter-project/docs/setup/configuration"}},f={},g=[{value:"A. GitHub's "Use this template" Option",id:"a-githubs-use-this-template-option",level:2},{value:"B. Manual Download",id:"b-manual-download",level:2},{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}],y={toc:g},b="wrapper";function w(e){let{components:t,...n}=e;return(0,o.kt)(b,(0,a.Z)({},y,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(r.Fragment,null,"There are two ways to use the ",s().title," as a template when creating a new project or rebasing an existing one."),(0,o.kt)("br",null),(0,o.kt)("h2",{id:"a-githubs-use-this-template-option"},'A. GitHub\'s "Use this template" Option'),(0,o.kt)(l.ZP,{mdxType:"UseTemplateGitHubPartial"}),(0,o.kt)("h2",{id:"b-manual-download"},"B. Manual Download"),(0,o.kt)("p",null,'If you do not wish to use GitHub\'s "Use this template" option, you may manually download the\ntemplate and take advantage of its features.'),(0,o.kt)("h3",{id:"step-1"},"Step 1"),(0,o.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Download ZIP'\noption under the 'Code' button on the ",(0,o.kt)("a",{href:s().repoUrl},"GitHub repository\npage"),"."),(0,o.kt)("p",null,"Alternatively, you may download the template from the ",(0,o.kt)("a",{href:s().repoArchiveUrl},"\nGitHub repository archive"),"."),(0,o.kt)("img",{src:p,alt:"GitHub code button menu download zip option",width:"400"}),(0,o.kt)("h3",{id:"step-2"},"Step 2"),(0,o.kt)("p",null,"After the ZIP file has downloaded, extract the contents to a new directory on your local machine."),(0,o.kt)("p",null,"If you wish to use the template as a new repository, you may create a new repository from the\nextracted contents. Otherwise, you may copy the contents to an existing repository."),(0,o.kt)("img",{src:c,alt:"GitHub downloaded zip extraction",width:"400"}),(0,o.kt)("h3",{id:"step-3"},"Step 3"),(0,o.kt)(r.Fragment,null,"Once the downloaded ZIP file has been extracted, you may begin using the\xa0",s().title,".")," Additional documentation may be found in the menu to the left (above on mobile).",(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}w.isMDXComponent=!0},4054:(e,t,n)=>{"use strict";n.d(t,{ZP:()=>h});var a=n(7462),r=n(7294),o=n(3905),i=n(8979),s=n.n(i);const l="data:image/webp;base64,UklGRjIGAABXRUJQVlA4TCUGAAAvrUASABrK8v+nkaNXaAgnJ7wxn5iTB+DkHZbhyHDfGymMPi1D0LPUFYauOAw924HuGp6xa1xWtSR7NN1aLUPHy8yMYeZ/6r8sx9o2tW5WcNHMzPZnZoaANuAV3E5laLrwVOqUipmT6ZTKGFZnZlVmq8qExqFPrrb9h+achW3bxhvbmgPYE5gq1q8LpwqnCtecKl8Va6os/9XHNf/Rf4O3/w7cSHKUqrsjQ5FhnhCNxL8JsGMqau7q3D1z6Pic4RP6sQgoua9jegbM7D00tWXnlMZtBNCPl76d2Xf4rs7d70oBM7r2E0BXzug+cFfnbpkV/yaAvvwbZXantu4igL58X2anOKVpOwH05ZGiBD+CzvzxlWwI7jk+HfrEgXg56fZyRcogUeDXRGCVOiu2mTBuAvIpgUcDltODvFt4LKFcvZLwAX4I7DJlXAYfVwhMSrkrrg7ymkbYADw/LxaetKMptYhMEavJIyxfSQxI5pn2DCnpcs6cAAGesQJ2YNCjyeghYoMnnUDEXM6Jb9ZOTHghsZa+4YA/LgTdKXfO00SPeu0chFhEfM+XyIqSE+oDDBfYQ/YqsZ5zy95ZkIBPNdO65xL+m97pucghuJFRKx/gvzt37hELYv4C9FT5GrFKf/hQuKtPX7mVWZ4RPFVgdooV3LHjmsIt8+YSPhbAcwPanHjumexw56jhzvAGT1owLnsfaEq9dk4WC/vACaylWq7cjNKU3BkKZz1U7rEwpZN+trJpFQBAYC1OSeUEKefMCVkgun2J7NGsNB+W33xS+c6ga1asVXezG/yykgGSQg6PunRnaLk7VOkb3BTYnB+r5iaWK3lODNlzpNSfCPmGdc/26XJu+YQk5cR3WdNDLAQtp6DwPGDjpGGhVGrKlZJ3IACB1L6jTZ9IAIDvADvf43hNd/iej0cvWic/50XCAX/iCXYDqzBBDfeaJ0Dg7M/F58hy6ADLLKPnP7AJQdwUQMi3EMTkqgWQfUD/y/aU3Jpfjv1uwCnzNCUxo4cMgRPIFd49AUezV78Awdn0gznPEKvMhwdcAIBY409kDeyVl9b3WAyD3QDP5KUGJPVA2TvGNUQf7wiNAW+yU1JrfiCwqybInhEowQcaMsseAHgAN/Y+07h1xy6V+lzinZhCfvnl0gEAkADAgL3DmaOGe4wr5AobX2JDfCDcC166xzWU2lp1TXFpcyro31Aaa1VYoynOknFAY8zTt5KVCn7pciW1Gkh5yg3J7kjKCX5uCvk/RwL+dzVm4m9TuGk1Z81BSDqDqZ0nm595vwdiYeKCKSUp1XciZYqU2lp9ssnr8ScGw47eHLjLhVczZyjNyjmwUtaWXHW+sVfJ4PmPS88N6DC4ZsIxhbPjptoR3IPGmR8IrM1SOSERbRNc++4swGYR9DTx8/ROD7EBa23f2SHLSHgQkhZgyFkl1vJDMCvhu5ro0ZTpgCEhJC2zPrg7xCyHfIkNktGva+eIn29YlQO89Of6HWI9g6mJOYaQzz630OHK+jkbGuUL8huf30rhVJYryhv75JT2yy27vrJJtkhP/Lpk9v3Db1+dkS3SE02Tee7fv87xVqus4nsaOkFBlaVJMo+SeAZUVAZF/r2qypFiw6sqkwHOkLyKEfkVN1W13lLdemt1Kyil1GRAlakLZ97LkZlP+r8bPHR4wMDBycU1B1Q6QmrqwnZmdB8ggAJyEM/U/fq1azvWPr3w6NGJxbWgipITLTYtnDVwdFrH3sJfQKRtUTXimervP57fm2+bUQBqOKV5x4mTktPCUIlJbAD8iB/VkE9i1ZUdcxmxb/tOkVBzRiNxIecgYsXXTcRFU2+0RyyaEk9kXo7F0v9h+NQeX/z12Y3ievP0Qo0Sj2eVvP+EeLxXyzZ9Eo0ld6pt3XO4hPibPgljsbTR1mnneAsDfTeeyAs1ZyyefvWZS8Hs2o7FEzmh7ozHM6Y97Alk3suRWDwj1J2xSGKbnLINayqIESdPRKNJofaMRVOPfuZf77v99I9Qg/7Rvalr1dw3YZ/79+8d8m4xGk0MdWg0mtImp2z/s5+/JJdnlsy+v/vG44sfRSMJoR6NROKPnY3Hs2PxrHgs/ffwtTMCAA==";var p=n(347),c=n(3221),u=n(7873);const m={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3},{value:"Step 4",id:"step-4",level:3}]},d="wrapper";function h(e){let{components:t,...n}=e;return(0,o.kt)(d,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,o.kt)("p",null,'The easiest way to use this template is to use GitHub\'s "Use this template" option. This will\nautomatically create a new repository from the template and allow you to clone the repository to\nyour local machine.'),(0,o.kt)("h3",{id:"step-1"},"Step 1"),(0,o.kt)("p",null,"To begin using the Solution Center Java Maven Starter Project, simply click the 'Use this template'\nbutton on the ",(0,o.kt)("a",{href:s().repoUrl},"GitHub repository page"),"."),(0,o.kt)("img",{src:l,alt:"Use this template button",width:"200"}),(0,o.kt)("h3",{id:"step-2"},"Step 2"),(0,o.kt)("p",null,"After the 'New repository' page has loaded, follow the steps requested to create a new repository\nfrom the template and submit."),(0,o.kt)("img",{src:p.Z,alt:"New repository from template page",width:"400"}),(0,o.kt)("h3",{id:"step-3"},"Step 3"),(0,o.kt)("p",null,"Once the new repository is created, you may clone the repository to your local machine using the\npreferred Git Client of your choice.",(0,o.kt)("br",null),(0,o.kt)("br",null)),(0,o.kt)("img",{src:c.Z,alt:"GitHub code button menu",width:"400"}),(0,o.kt)("h3",{id:"step-4"},"Step 4"),(0,o.kt)(r.Fragment,null,"Once the new repository has been cloned, you may continue with setting up and using the\xa0",s().title,"."),(0,o.kt)("br",null),(0,o.kt)("br",null),(0,o.kt)("img",{src:u.Z,alt:"Green check mark",width:"100"}))}h.isMDXComponent=!0},3221:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-code-btn-menu-e320f01043ae039105bb6b6b6260b5f2.webp"},347:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/github-template-repo-setup-823e2db89e15f53a89643c0c7d5ba216.webp"},7873:(e,t,n)=>{"use strict";n.d(t,{Z:()=>a});const a=n.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"}}]); \ No newline at end of file diff --git a/assets/js/c7569f72.26c214f8.js b/assets/js/c7569f72.26c214f8.js deleted file mode 100644 index 480fb39..0000000 --- a/assets/js/c7569f72.26c214f8.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[779],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>u,kt:()=>f});var o=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=o.createContext({}),l=function(e){var t=o.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return o.createElement(s.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,a=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),c=l(r),d=n,f=c["".concat(s,".").concat(d)]||c[d]||m[d]||a;return r?o.createElement(f,i(i({ref:t},u),{},{components:r})):o.createElement(f,i({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var a=r.length,i=new Array(a);i[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:n,i[1]=p;for(var l=2;l{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},6496:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>u,toc:()=>m});var o=r(7462),n=r(7294),a=r(3905),i=r(8979),p=r.n(i);const s={id:"support",title:"Support",sidebar_label:"Support"},l=void 0,u={unversionedId:"help/support",id:"help/support",title:"Support",description:"While this project is intended to replace the functionality provided by the Ewon JTK's build.xml",source:"@site/docs/06-help/03-SUPPORT.mdx",sourceDirName:"06-help",slug:"/help/support",permalink:"/sc-java-maven-starter-project/docs/help/support",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/03-SUPPORT.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{id:"support",title:"Support",sidebar_label:"Support"},sidebar:"defaultSidebar",previous:{title:"Troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting"},next:{title:"Terms of Use",permalink:"/sc-java-maven-starter-project/docs/legal/terms-of-use"}},c={},m=[{value:"GitHub Issues",id:"github-issues",level:2},{value:"HMS Networks Support Portal",id:"hms-networks-support-portal",level:2}],d={toc:m},f="wrapper";function h(e){let{components:t,...r}=e;return(0,a.kt)(f,(0,o.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"While this project is intended to replace the functionality provided by the Ewon JTK's ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml"),"\nAnt build file, the Ewon-supplied ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file remains the only officially supported\nenvironment for Ewon Java development. For more information about the official\nEwon-supplied ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, please refer\nto ",(0,a.kt)("a",{parentName:"p",href:"https://developer.ewon.biz/content/java-0"},"https://developer.ewon.biz/content/java-0"),".")),(0,a.kt)(n.Fragment,null,"The ",p().title," is supported by the HMS Networks North American Offices."),(0,a.kt)("br",null),(0,a.kt)("h2",{id:"github-issues"},"GitHub Issues"),(0,a.kt)(n.Fragment,null,"For concerns regarding the functionality and features of the ",p().title,", please ",(0,a.kt)("a",{href:p().repoNewIssueUrl},"create an issue"),' using the "Issues" tab on the ',(0,a.kt)("a",{href:p().repoUrl},"GitHub repository page")),".",(0,a.kt)("br",null),(0,a.kt)("h2",{id:"hms-networks-support-portal"},"HMS Networks Support Portal"),(0,a.kt)("p",null,"For all other inquiries, please use the\n",(0,a.kt)("a",{parentName:"p",href:"https://support.hms-networks.com/hc/en-us"},"HMS Networks Support Portal"),"."))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c7569f72.9e16e70f.js b/assets/js/c7569f72.9e16e70f.js new file mode 100644 index 0000000..f9a48fc --- /dev/null +++ b/assets/js/c7569f72.9e16e70f.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[779],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>u,kt:()=>f});var o=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);t&&(o=o.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,o)}return r}function i(e){for(var t=1;t=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(o=0;o=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=o.createContext({}),l=function(e){var t=o.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},u=function(e){var t=l(e.components);return o.createElement(s.Provider,{value:t},e.children)},c="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return o.createElement(o.Fragment,{},t)}},d=o.forwardRef((function(e,t){var r=e.components,n=e.mdxType,a=e.originalType,s=e.parentName,u=p(e,["components","mdxType","originalType","parentName"]),c=l(r),d=n,f=c["".concat(s,".").concat(d)]||c[d]||m[d]||a;return r?o.createElement(f,i(i({ref:t},u),{},{components:r})):o.createElement(f,i({ref:t},u))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var a=r.length,i=new Array(a);i[0]=d;var p={};for(var s in t)hasOwnProperty.call(t,s)&&(p[s]=t[s]);p.originalType=e,p[c]="string"==typeof e?e:n,i[1]=p;for(var l=2;l{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},6496:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>c,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>u,toc:()=>m});var o=r(7462),n=r(7294),a=r(3905),i=r(8979),p=r.n(i);const s={id:"support",title:"Support",sidebar_label:"Support"},l=void 0,u={unversionedId:"help/support",id:"help/support",title:"Support",description:"While this project is intended to replace the functionality provided by the Ewon JTK's build.xml",source:"@site/docs/06-help/03-SUPPORT.mdx",sourceDirName:"06-help",slug:"/help/support",permalink:"/sc-java-maven-starter-project/docs/help/support",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/03-SUPPORT.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{id:"support",title:"Support",sidebar_label:"Support"},sidebar:"defaultSidebar",previous:{title:"Troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting"},next:{title:"Terms of Use",permalink:"/sc-java-maven-starter-project/docs/legal/terms-of-use"}},c={},m=[{value:"GitHub Issues",id:"github-issues",level:2},{value:"HMS Networks Support Portal",id:"hms-networks-support-portal",level:2}],d={toc:m},f="wrapper";function h(e){let{components:t,...r}=e;return(0,a.kt)(f,(0,o.Z)({},d,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"While this project is intended to replace the functionality provided by the Ewon JTK's ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml"),"\nAnt build file, the Ewon-supplied ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file remains the only officially supported\nenvironment for Ewon Java development. For more information about the official\nEwon-supplied ",(0,a.kt)("inlineCode",{parentName:"p"},"build.xml")," Ant build file, please refer\nto ",(0,a.kt)("a",{parentName:"p",href:"https://developer.ewon.biz/content/java-0"},"https://developer.ewon.biz/content/java-0"),".")),(0,a.kt)(n.Fragment,null,"The ",p().title," is supported by the HMS Networks North American Offices."),(0,a.kt)("br",null),(0,a.kt)("h2",{id:"github-issues"},"GitHub Issues"),(0,a.kt)(n.Fragment,null,"For concerns regarding the functionality and features of the ",p().title,", please ",(0,a.kt)("a",{href:p().repoNewIssueUrl},"create an issue"),' using the "Issues" tab on the ',(0,a.kt)("a",{href:p().repoUrl},"GitHub repository page")),".",(0,a.kt)("br",null),(0,a.kt)("h2",{id:"hms-networks-support-portal"},"HMS Networks Support Portal"),(0,a.kt)("p",null,"For all other inquiries, please use the\n",(0,a.kt)("a",{parentName:"p",href:"https://support.hms-networks.com/hc/en-us"},"HMS Networks Support Portal"),"."))}h.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c798ae01.0a7f1a76.js b/assets/js/c798ae01.0a7f1a76.js deleted file mode 100644 index fb57831..0000000 --- a/assets/js/c798ae01.0a7f1a76.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[714],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>m,kt:()=>h});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=p(n),c=o,h=u["".concat(s,".").concat(c)]||u[c]||d[c]||a;return n?r.createElement(h,i(i({ref:t},m),{},{components:n})):r.createElement(h,i({ref:t},m))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:o,i[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},3717:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>s,metadata:()=>m,toc:()=>d});var r=n(7462),o=n(7294),a=n(3905),i=n(8979),l=n.n(i);const s={id:"troubleshooting",title:"Troubleshooting",sidebar_label:"Troubleshooting"},p=void 0,m={unversionedId:"help/troubleshooting",id:"help/troubleshooting",title:"Troubleshooting",description:"Disclaimer",source:"@site/docs/06-help/02-TROUBLESHOOTING.mdx",sourceDirName:"06-help",slug:"/help/troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/02-TROUBLESHOOTING.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"troubleshooting",title:"Troubleshooting",sidebar_label:"Troubleshooting"},sidebar:"defaultSidebar",previous:{title:"Frequently Asked Questions",permalink:"/sc-java-maven-starter-project/docs/help/faq"},next:{title:"Support",permalink:"/sc-java-maven-starter-project/docs/help/support"}},u={},d=[{value:"Disclaimer",id:"disclaimer",level:2},{value:"1. IDE Auto-Import Errors",id:"1-ide-auto-import-errors",level:2},{value:"Symptom",id:"symptom",level:3},{value:"Cause",id:"cause",level:3},{value:"Solution",id:"solution",level:3},{value:"2. Build Warnings or Errors in ExampleMain or ExampleTest",id:"2-build-warnings-or-errors-in-examplemain-or-exampletest",level:2},{value:"Symptom",id:"symptom-1",level:3},{value:"Cause",id:"cause-1",level:3},{value:"Solution",id:"solution-1",level:3},{value:"3. Javadoc Errors During Build After Updating the POM File",id:"3-javadoc-errors-during-build-after-updating-the-pom-file",level:2},{value:"Symptom",id:"symptom-2",level:3},{value:"Cause",id:"cause-2",level:3},{value:"Solution",id:"solution-2",level:3}],c={toc:d},h="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(h,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"disclaimer"},"Disclaimer"),(0,a.kt)(o.Fragment,null,"The information provided in this section is intended to assist with troubleshooting common issues that may be encountered when using the ",l().title,". This information is provided as-is, and is not intended to be a comprehensive troubleshooting guide."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"If you are unable to resolve an issue using the information provided in this section, please\nvisit the ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/support"},"Support")," page for additional support options."),(0,a.kt)("h2",{id:"1-ide-auto-import-errors"},"1. IDE Auto-Import Errors"),(0,a.kt)("h3",{id:"symptom"},"Symptom"),(0,a.kt)(o.Fragment,null,"When using an IDE that supports auto-import functionality, such as IntelliJ IDEA, you may encounter errors during the auto-import process for the ",l().title,". These errors may display as messages and/or project source files may be hidden in the IDE."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause"},"Cause"),(0,a.kt)("p",null,"In most cases, these errors are likely caused by an issue with the project configuration files,\nsuch as the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file."),(0,a.kt)("h3",{id:"solution"},"Solution"),(0,a.kt)("p",null,"To resolve these errors, try the following:"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Double-check that the project configuration files are valid and all required steps were completed\nduring setup."),(0,a.kt)("li",{parentName:"ol"},"If the project configuration files are valid, try restarting the IDE and re-importing the\nproject.",(0,a.kt)("ol",{parentName:"li"},(0,a.kt)("li",{parentName:"ol"},'Some IDEs may include an option to "Invalidate Caches and Restart" when restarting.\nIf this option is available, try using it before re-importing the project. Note: This option\nmay be found in the "File" menu.'))),(0,a.kt)("li",{parentName:"ol"},"If the errors persist, try reverting to a previously known good commit, or resetting local\nchanges.")),(0,a.kt)("h2",{id:"2-build-warnings-or-errors-in-examplemain-or-exampletest"},"2. Build Warnings or Errors in ExampleMain or ExampleTest"),(0,a.kt)("h3",{id:"symptom-1"},"Symptom"),(0,a.kt)(o.Fragment,null,"When building the ",l().title,", you may encounter build warnings or errors in the `ExampleMain.java` or `ExampleTest.java` files. These errors may prevent the build from completing successfully."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause-1"},"Cause"),(0,a.kt)(o.Fragment,null,"The `ExampleMain.java` and `ExampleTest.java` files are included in the ",l().title,"\xa0as an example. These files are not required for the ",l().title," to function properly, and may be removed if desired."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"solution-1"},"Solution"),(0,a.kt)("p",null,"If you do not wish to use the ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleMain.java")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleTest.java")," files, you may remove them\nfrom the project."),(0,a.kt)("p",null,"If you wish to use the ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleMain.java")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleTest.java")," files, you may need to update the\nfiles to resolve the identified build warnings or errors. The following recommendations may be\nhelpful when updating the files:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"The ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java")," file contains a ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()")," method that returns an ",(0,a.kt)("inlineCode",{parentName:"li"},"int")," value.\nThis method may be updated to return a different value, or removed if desired."),(0,a.kt)("li",{parentName:"ul"},"The ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file contains a handful of methods which perform basic mathematics\noperations on the return value from ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()")," in ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java"),".\nThese methods may be updated to perform different operations, or removed if desired.",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Optionally, the ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file may be deleted if desired. Note: if the\n",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file is deleted, it is recommended to also remove the ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()"),"\nmethod from ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java"),".")))),(0,a.kt)("h2",{id:"3-javadoc-errors-during-build-after-updating-the-pom-file"},"3. Javadoc Errors During Build After Updating the POM File"),(0,a.kt)("h3",{id:"symptom-2"},"Symptom"),(0,a.kt)(o.Fragment,null,"When building the ",l().title,", you may encounter build errors related to the generation of Javadocs. These errors may prevent the build from completing successfully."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause-2"},"Cause"),(0,a.kt)("p",null,"A recently added or updated dependency in the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file may include invalid Javadocs, or the\nJavadocs may not be available."),(0,a.kt)("h3",{id:"solution-2"},"Solution"),(0,a.kt)("p",null,"Dependencies that introduce Javadoc errors may be excluded from the Javadoc generation process by\nmodifying the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file."),(0,a.kt)("p",null,"To exclude a dependency from the Javadoc generation process, add a\ncorresponding ",(0,a.kt)("inlineCode",{parentName:"p"},"")," to\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"org.apache.maven.plugins:maven-javadoc-plugin")," ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),"."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"For example, to exclude the Javadoc documentation for the ",(0,a.kt)("inlineCode",{parentName:"p"},"commons-lang:commons-lang")," dependency,\nadd the following to\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"org.apache.maven.plugins:maven-javadoc-plugin")," ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),":"),(0,a.kt)("pre",{parentName:"admonition"},(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\ncommons-lang:commons-lang:*\n"))))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c798ae01.9eae191b.js b/assets/js/c798ae01.9eae191b.js new file mode 100644 index 0000000..0d183aa --- /dev/null +++ b/assets/js/c798ae01.9eae191b.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[714],{3905:(e,t,n)=>{"use strict";n.d(t,{Zo:()=>m,kt:()=>h});var r=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function a(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function i(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=r.createContext({}),p=function(e){var t=r.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):i(i({},t),e)),n},m=function(e){var t=p(e.components);return r.createElement(s.Provider,{value:t},e.children)},u="mdxType",d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.createElement(r.Fragment,{},t)}},c=r.forwardRef((function(e,t){var n=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,m=l(e,["components","mdxType","originalType","parentName"]),u=p(n),c=o,h=u["".concat(s,".").concat(c)]||u[c]||d[c]||a;return n?r.createElement(h,i(i({ref:t},m),{},{components:n})):r.createElement(h,i({ref:t},m))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=n.length,i=new Array(a);i[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[u]="string"==typeof e?e:o,i[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},3717:(e,t,n)=>{"use strict";n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>p,default:()=>f,frontMatter:()=>s,metadata:()=>m,toc:()=>d});var r=n(7462),o=n(7294),a=n(3905),i=n(8979),l=n.n(i);const s={id:"troubleshooting",title:"Troubleshooting",sidebar_label:"Troubleshooting"},p=void 0,m={unversionedId:"help/troubleshooting",id:"help/troubleshooting",title:"Troubleshooting",description:"Disclaimer",source:"@site/docs/06-help/02-TROUBLESHOOTING.mdx",sourceDirName:"06-help",slug:"/help/troubleshooting",permalink:"/sc-java-maven-starter-project/docs/help/troubleshooting",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/06-help/02-TROUBLESHOOTING.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"troubleshooting",title:"Troubleshooting",sidebar_label:"Troubleshooting"},sidebar:"defaultSidebar",previous:{title:"Frequently Asked Questions",permalink:"/sc-java-maven-starter-project/docs/help/faq"},next:{title:"Support",permalink:"/sc-java-maven-starter-project/docs/help/support"}},u={},d=[{value:"Disclaimer",id:"disclaimer",level:2},{value:"1. IDE Auto-Import Errors",id:"1-ide-auto-import-errors",level:2},{value:"Symptom",id:"symptom",level:3},{value:"Cause",id:"cause",level:3},{value:"Solution",id:"solution",level:3},{value:"2. Build Warnings or Errors in ExampleMain or ExampleTest",id:"2-build-warnings-or-errors-in-examplemain-or-exampletest",level:2},{value:"Symptom",id:"symptom-1",level:3},{value:"Cause",id:"cause-1",level:3},{value:"Solution",id:"solution-1",level:3},{value:"3. Javadoc Errors During Build After Updating the POM File",id:"3-javadoc-errors-during-build-after-updating-the-pom-file",level:2},{value:"Symptom",id:"symptom-2",level:3},{value:"Cause",id:"cause-2",level:3},{value:"Solution",id:"solution-2",level:3}],c={toc:d},h="wrapper";function f(e){let{components:t,...n}=e;return(0,a.kt)(h,(0,r.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"disclaimer"},"Disclaimer"),(0,a.kt)(o.Fragment,null,"The information provided in this section is intended to assist with troubleshooting common issues that may be encountered when using the ",l().title,". This information is provided as-is, and is not intended to be a comprehensive troubleshooting guide."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"If you are unable to resolve an issue using the information provided in this section, please\nvisit the ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/support"},"Support")," page for additional support options."),(0,a.kt)("h2",{id:"1-ide-auto-import-errors"},"1. IDE Auto-Import Errors"),(0,a.kt)("h3",{id:"symptom"},"Symptom"),(0,a.kt)(o.Fragment,null,"When using an IDE that supports auto-import functionality, such as IntelliJ IDEA, you may encounter errors during the auto-import process for the ",l().title,". These errors may display as messages and/or project source files may be hidden in the IDE."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause"},"Cause"),(0,a.kt)("p",null,"In most cases, these errors are likely caused by an issue with the project configuration files,\nsuch as the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file."),(0,a.kt)("h3",{id:"solution"},"Solution"),(0,a.kt)("p",null,"To resolve these errors, try the following:"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},"Double-check that the project configuration files are valid and all required steps were completed\nduring setup."),(0,a.kt)("li",{parentName:"ol"},"If the project configuration files are valid, try restarting the IDE and re-importing the\nproject.",(0,a.kt)("ol",{parentName:"li"},(0,a.kt)("li",{parentName:"ol"},'Some IDEs may include an option to "Invalidate Caches and Restart" when restarting.\nIf this option is available, try using it before re-importing the project. Note: This option\nmay be found in the "File" menu.'))),(0,a.kt)("li",{parentName:"ol"},"If the errors persist, try reverting to a previously known good commit, or resetting local\nchanges.")),(0,a.kt)("h2",{id:"2-build-warnings-or-errors-in-examplemain-or-exampletest"},"2. Build Warnings or Errors in ExampleMain or ExampleTest"),(0,a.kt)("h3",{id:"symptom-1"},"Symptom"),(0,a.kt)(o.Fragment,null,"When building the ",l().title,", you may encounter build warnings or errors in the `ExampleMain.java` or `ExampleTest.java` files. These errors may prevent the build from completing successfully."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause-1"},"Cause"),(0,a.kt)(o.Fragment,null,"The `ExampleMain.java` and `ExampleTest.java` files are included in the ",l().title,"\xa0as an example. These files are not required for the ",l().title," to function properly, and may be removed if desired."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"solution-1"},"Solution"),(0,a.kt)("p",null,"If you do not wish to use the ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleMain.java")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleTest.java")," files, you may remove them\nfrom the project."),(0,a.kt)("p",null,"If you wish to use the ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleMain.java")," and ",(0,a.kt)("inlineCode",{parentName:"p"},"ExampleTest.java")," files, you may need to update the\nfiles to resolve the identified build warnings or errors. The following recommendations may be\nhelpful when updating the files:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},"The ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java")," file contains a ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()")," method that returns an ",(0,a.kt)("inlineCode",{parentName:"li"},"int")," value.\nThis method may be updated to return a different value, or removed if desired."),(0,a.kt)("li",{parentName:"ul"},"The ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file contains a handful of methods which perform basic mathematics\noperations on the return value from ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()")," in ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java"),".\nThese methods may be updated to perform different operations, or removed if desired.",(0,a.kt)("ul",{parentName:"li"},(0,a.kt)("li",{parentName:"ul"},"Optionally, the ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file may be deleted if desired. Note: if the\n",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleTest.java")," file is deleted, it is recommended to also remove the ",(0,a.kt)("inlineCode",{parentName:"li"},"getExampleValue()"),"\nmethod from ",(0,a.kt)("inlineCode",{parentName:"li"},"ExampleMain.java"),".")))),(0,a.kt)("h2",{id:"3-javadoc-errors-during-build-after-updating-the-pom-file"},"3. Javadoc Errors During Build After Updating the POM File"),(0,a.kt)("h3",{id:"symptom-2"},"Symptom"),(0,a.kt)(o.Fragment,null,"When building the ",l().title,", you may encounter build errors related to the generation of Javadocs. These errors may prevent the build from completing successfully."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"cause-2"},"Cause"),(0,a.kt)("p",null,"A recently added or updated dependency in the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file may include invalid Javadocs, or the\nJavadocs may not be available."),(0,a.kt)("h3",{id:"solution-2"},"Solution"),(0,a.kt)("p",null,"Dependencies that introduce Javadoc errors may be excluded from the Javadoc generation process by\nmodifying the ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," file."),(0,a.kt)("p",null,"To exclude a dependency from the Javadoc generation process, add a\ncorresponding ",(0,a.kt)("inlineCode",{parentName:"p"},"")," to\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"org.apache.maven.plugins:maven-javadoc-plugin")," ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),"."),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"For example, to exclude the Javadoc documentation for the ",(0,a.kt)("inlineCode",{parentName:"p"},"commons-lang:commons-lang")," dependency,\nadd the following to\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"org.apache.maven.plugins:maven-javadoc-plugin")," ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),":"),(0,a.kt)("pre",{parentName:"admonition"},(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\ncommons-lang:commons-lang:*\n"))))}f.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/c92e68d7.9ad16975.js b/assets/js/c92e68d7.9ad16975.js new file mode 100644 index 0000000..7392180 --- /dev/null +++ b/assets/js/c92e68d7.9ad16975.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[708],{3905:(e,t,i)=>{"use strict";i.d(t,{Zo:()=>d,kt:()=>f});var n=i(7294);function o(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}function a(e,t){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),i.push.apply(i,n)}return i}function r(e){for(var t=1;t=0||(o[i]=e[i]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(o[i]=e[i])}return o}var s=n.createContext({}),p=function(e){var t=n.useContext(s),i=t;return e&&(i="function"==typeof e?e(t):r(r({},t),e)),i},d=function(e){var t=p(e.components);return n.createElement(s.Provider,{value:t},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var i=e.components,o=e.mdxType,a=e.originalType,s=e.parentName,d=l(e,["components","mdxType","originalType","parentName"]),c=p(i),m=o,f=c["".concat(s,".").concat(m)]||c[m]||u[m]||a;return i?n.createElement(f,r(r({ref:t},d),{},{components:i})):n.createElement(f,r({ref:t},d))}));function f(e,t){var i=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=i.length,r=new Array(a);r[0]=m;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[c]="string"==typeof e?e:o,r[1]=l;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},9608:(e,t,i)=>{"use strict";i.r(t),i.d(t,{assets:()=>m,contentTitle:()=>c,default:()=>v,frontMatter:()=>d,metadata:()=>u,toc:()=>f});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),l=i.n(r),s=(i(9776),i(4976),i(8981)),p=i(6902);const d={id:"configuration",title:"Configuration",sidebar_label:"Configuration"},c=void 0,u={unversionedId:"setup/configuration",id:"setup/configuration",title:"Configuration",description:"There are a handful of configuration files which must be appropriately updated prior to using",source:"@site/docs/04-setup/02-CONFIGURATION.mdx",sourceDirName:"04-setup",slug:"/setup/configuration",permalink:"/sc-java-maven-starter-project/docs/setup/configuration",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/04-setup/02-CONFIGURATION.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"configuration",title:"Configuration",sidebar_label:"Configuration"},sidebar:"defaultSidebar",previous:{title:"Using Template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template"},next:{title:"Features",permalink:"/sc-java-maven-starter-project/docs/usage/features"}},m={},f=[{value:"Configuring the Maven POM File",id:"configuring-the-maven-pom-file",level:2},{value:"POM File Fields",id:"pom-file-fields",level:3},{value:"name",id:"name",level:4},{value:"version",id:"version",level:4},{value:"groupId",id:"groupid",level:4},{value:"artifactId",id:"artifactid",level:4},{value:"project.main.class",id:"projectmainclass",level:4},{value:"Configuring the Documentation",id:"configuring-the-documentation",level:2},{value:"Docusaurus Configuration Fields",id:"docusaurus-configuration-fields",level:3},{value:"repoOwnerName",id:"repoownername",level:4},{value:"repoName",id:"reponame",level:4},{value:"title",id:"title",level:4},{value:"description",id:"description",level:4},{value:"meta",id:"meta",level:4},{value:"configFileName",id:"configfilename",level:4},{value:"applicationJarFileName",id:"applicationjarfilename",level:4}],h={toc:f},g="wrapper";function v(e){let{components:t,...i}=e;return(0,a.kt)(g,(0,n.Z)({},h,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"There are a handful of configuration files which must be appropriately updated prior to using the ",l().title," as a template."),(0,a.kt)("br",null),(0,a.kt)("h2",{id:"configuring-the-maven-pom-file"},"Configuring the Maven POM File"),(0,a.kt)(s.ZP,{mdxType:"ConfiguringMavenPomFilePartial"}),(0,a.kt)("h3",{id:"pom-file-fields"},"POM File Fields"),(0,a.kt)("h4",{id:"name"},"name"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"name")," field modifies the project's name. This field is used by the Maven build system to\nname the project's JAR file, and is used by the application to display the project's name."),(0,a.kt)("h4",{id:"version"},"version"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"version")," field modifies the project's version. This field is used by the Maven build system\nto name the project's JAR file, and is used by the application to display the project's version."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"The version number must follow the ",(0,a.kt)("a",{parentName:"p",href:"https://semver.org/"},"Semantic Versioning")," standard."),(0,a.kt)("p",{parentName:"admonition"},"For example, the version number ",(0,a.kt)("inlineCode",{parentName:"p"},"1.0.0")," is valid, but the version number ",(0,a.kt)("inlineCode",{parentName:"p"},"1.0")," is not valid.")),(0,a.kt)("h4",{id:"groupid"},"groupId"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"groupId")," field modifies the project's group ID. This field is used to uniquely identify a\nproject, or set of projects within a single organization. This field is commonly used in\nmultiple module projects to group modules together."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"The group ID must follow\nthe ",(0,a.kt)("a",{parentName:"p",href:"https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html"},"Java Package Naming Conventions"),"."),(0,a.kt)("p",{parentName:"admonition"},"For example, the group ID ",(0,a.kt)("inlineCode",{parentName:"p"},"com.example.project")," is valid, but the group ID ",(0,a.kt)("inlineCode",{parentName:"p"},"com.example-project")," is\nnot valid.")),(0,a.kt)("h4",{id:"artifactid"},"artifactId"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"artifactId")," field modifies the project's artifact ID. This field is used to uniquely identify\na project within a group ID, and is the name of the jar without version. In multiple module\nprojects, this field is commonly used to name the individual module."),(0,a.kt)("h4",{id:"projectmainclass"},"project.main.class"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"project.main.class")," field modifies the project's main class. This field is used by the Maven\nbuild system to specify the project's main class, and is used by the application to launch the\nproject's main class."),(0,a.kt)("h2",{id:"configuring-the-documentation"},"Configuring the Documentation"),(0,a.kt)(p.ZP,{mdxType:"ConfiguringDocusaurusPartial"}),(0,a.kt)("h3",{id:"docusaurus-configuration-fields"},"Docusaurus Configuration Fields"),(0,a.kt)("h4",{id:"repoownername"},"repoOwnerName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"repoOwnerName")," field modifies the project's repository owner name. This field is used\nfor creating links used by the download button(s) and repository references in the documentation."),(0,a.kt)("h4",{id:"reponame"},"repoName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"repoName")," field modifies the project's repository name. This field is used for creating links\nused by the download button(s) and repository references in the documentation."),(0,a.kt)("h4",{id:"title"},"title"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"title")," field modifies the project's title. This field is used by the documentation to display\nthe project's title."),(0,a.kt)("h4",{id:"description"},"description"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"description")," field modifies the project's description. This field is used by the documentation\nto display the project's description on the home page."),(0,a.kt)("h4",{id:"meta"},"meta"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"meta")," field modifies the project's meta information. This field is used by the documentation\nto include meta information in the project's HTML pages, which is used by search engines and\nsocial media websites to display information about the project and/or documentation website."),(0,a.kt)("h4",{id:"configfilename"},"configFileName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"configFileName")," field modifies the project's configuration file name. This field is used by\nthe documentation to display the name of the configuration file used by the application."),(0,a.kt)("h4",{id:"applicationjarfilename"},"applicationJarFileName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"applicationJarFileName")," field modifies the project's application JAR file name. This field is\nused by the documentation to display the name of the JAR file used by the application."))}v.isMDXComponent=!0},6902:(e,t,i)=>{"use strict";i.d(t,{ZP:()=>u});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),l=i.n(r),s=i(4976),p=i(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},c="wrapper";function u(e){let{components:t,...i}=e;return(0,a.kt)(c,(0,n.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("em",{parentName:"p"},"File Location: ",(0,a.kt)("inlineCode",{parentName:"em"},"web-docs/ScDocusaurusConfig.js"))),(0,a.kt)("p",null,"The documentation configuration file is used to configure the documentation's title, description,\nand GitHub repository information, and must be updated before the documentation can be built."),(0,a.kt)("h3",{id:"step-1"},"Step 1"),(0,a.kt)("p",null,"Open the documentation configuration file located at ",(0,a.kt)("inlineCode",{parentName:"p"},"web-docs/ScDocusaurusConfig.js")," in your\nfavorite text editor."),(0,a.kt)("h3",{id:"step-2"},"Step 2"),(0,a.kt)("p",null,"Update the values of the following fields within the documentation configuration\nfile: ",(0,a.kt)("inlineCode",{parentName:"p"},"repoOwnerName"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"repoName"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", and ",(0,a.kt)("inlineCode",{parentName:"p"},"meta"),"."),(0,a.kt)("img",{src:s.Z,alt:"Docusaurus config file fields highlighted"}),(0,a.kt)("h3",{id:"step-3"},"Step 3"),(0,a.kt)(o.Fragment,null,"After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the ",l().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}u.isMDXComponent=!0},8981:(e,t,i)=>{"use strict";i.d(t,{ZP:()=>u});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),l=i.n(r),s=i(9776),p=i(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},c="wrapper";function u(e){let{components:t,...i}=e;return(0,a.kt)(c,(0,n.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("em",{parentName:"p"},"File Location: ",(0,a.kt)("inlineCode",{parentName:"em"},"pom.xml"))),(0,a.kt)("p",null,"The Maven POM file is used to configure the project's dependencies, build process, and\nother project settings. This includes the project's name, version, description, and main class,\nwhich must be configured before the project can be built."),(0,a.kt)("h3",{id:"step-1"},"Step 1"),(0,a.kt)("p",null,"Open the Maven POM file located at ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," in your favorite text editor."),(0,a.kt)("h3",{id:"step-2"},"Step 2"),(0,a.kt)("p",null,"Update the values of the following fields within the Maven POM\nFile: ",(0,a.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"version"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"artifactId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"project.main.class"),"."),(0,a.kt)("img",{src:s.Z,alt:"Maven pom file fields highlighted"}),(0,a.kt)("h3",{id:"step-3"},"Step 3"),(0,a.kt)(o.Fragment,null,"After saving the changes to the Maven POM file, the project can be built, and you may continue setting up and using the ",l().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}u.isMDXComponent=!0},4976:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/docusaurus-update-project-info-93b51f9b35aa9d7270a537d66ff853f5.webp"},7873:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"},9776:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/pom-update-project-info-1598b2441cec71969f0e3e1829f2ffb9.webp"}}]); \ No newline at end of file diff --git a/assets/js/c92e68d7.a814fc04.js b/assets/js/c92e68d7.a814fc04.js deleted file mode 100644 index 2c52342..0000000 --- a/assets/js/c92e68d7.a814fc04.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[708],{3905:(e,t,i)=>{"use strict";i.d(t,{Zo:()=>d,kt:()=>f});var n=i(7294);function o(e,t,i){return t in e?Object.defineProperty(e,t,{value:i,enumerable:!0,configurable:!0,writable:!0}):e[t]=i,e}function a(e,t){var i=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),i.push.apply(i,n)}return i}function r(e){for(var t=1;t=0||(o[i]=e[i]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,i)&&(o[i]=e[i])}return o}var l=n.createContext({}),p=function(e){var t=n.useContext(l),i=t;return e&&(i="function"==typeof e?e(t):r(r({},t),e)),i},d=function(e){var t=p(e.components);return n.createElement(l.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var i=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,d=s(e,["components","mdxType","originalType","parentName"]),u=p(i),m=o,f=u["".concat(l,".").concat(m)]||u[m]||c[m]||a;return i?n.createElement(f,r(r({ref:t},d),{},{components:i})):n.createElement(f,r({ref:t},d))}));function f(e,t){var i=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=i.length,r=new Array(a);r[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[u]="string"==typeof e?e:o,r[1]=s;for(var p=2;p{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},9608:(e,t,i)=>{"use strict";i.r(t),i.d(t,{assets:()=>m,contentTitle:()=>u,default:()=>v,frontMatter:()=>d,metadata:()=>c,toc:()=>f});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),s=i.n(r),l=(i(9776),i(4976),i(8981)),p=i(6902);const d={id:"configuration",title:"Configuration",sidebar_label:"Configuration"},u=void 0,c={unversionedId:"setup/configuration",id:"setup/configuration",title:"Configuration",description:"There are a handful of configuration files which must be appropriately updated prior to using",source:"@site/docs/04-setup/02-CONFIGURATION.mdx",sourceDirName:"04-setup",slug:"/setup/configuration",permalink:"/sc-java-maven-starter-project/docs/setup/configuration",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/04-setup/02-CONFIGURATION.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"configuration",title:"Configuration",sidebar_label:"Configuration"},sidebar:"defaultSidebar",previous:{title:"Using Template",permalink:"/sc-java-maven-starter-project/docs/setup/using-template"},next:{title:"Features",permalink:"/sc-java-maven-starter-project/docs/usage/features"}},m={},f=[{value:"Configuring the Maven POM File",id:"configuring-the-maven-pom-file",level:2},{value:"POM File Fields",id:"pom-file-fields",level:3},{value:"name",id:"name",level:4},{value:"version",id:"version",level:4},{value:"groupId",id:"groupid",level:4},{value:"artifactId",id:"artifactid",level:4},{value:"project.main.class",id:"projectmainclass",level:4},{value:"Configuring the Documentation",id:"configuring-the-documentation",level:2},{value:"Docusaurus Configuration Fields",id:"docusaurus-configuration-fields",level:3},{value:"repoOwnerName",id:"repoownername",level:4},{value:"repoName",id:"reponame",level:4},{value:"title",id:"title",level:4},{value:"description",id:"description",level:4},{value:"meta",id:"meta",level:4},{value:"configFileName",id:"configfilename",level:4}],h={toc:f},g="wrapper";function v(e){let{components:t,...i}=e;return(0,a.kt)(g,(0,n.Z)({},h,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"There are a handful of configuration files which must be appropriately updated prior to using the ",s().title," as a template."),(0,a.kt)("br",null),(0,a.kt)("h2",{id:"configuring-the-maven-pom-file"},"Configuring the Maven POM File"),(0,a.kt)(l.ZP,{mdxType:"ConfiguringMavenPomFilePartial"}),(0,a.kt)("h3",{id:"pom-file-fields"},"POM File Fields"),(0,a.kt)("h4",{id:"name"},"name"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"name")," field modifies the project's name. This field is used by the Maven build system to\nname the project's JAR file, and is used by the application to display the project's name."),(0,a.kt)("h4",{id:"version"},"version"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"version")," field modifies the project's version. This field is used by the Maven build system\nto name the project's JAR file, and is used by the application to display the project's version."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"The version number must follow the ",(0,a.kt)("a",{parentName:"p",href:"https://semver.org/"},"Semantic Versioning")," standard."),(0,a.kt)("p",{parentName:"admonition"},"For example, the version number ",(0,a.kt)("inlineCode",{parentName:"p"},"1.0.0")," is valid, but the version number ",(0,a.kt)("inlineCode",{parentName:"p"},"1.0")," is not valid.")),(0,a.kt)("h4",{id:"groupid"},"groupId"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"groupId")," field modifies the project's group ID. This field is used to uniquely identify a\nproject, or set of projects within a single organization. This field is commonly used in\nmultiple module projects to group modules together."),(0,a.kt)("admonition",{type:"tip"},(0,a.kt)("p",{parentName:"admonition"},"The group ID must follow\nthe ",(0,a.kt)("a",{parentName:"p",href:"https://docs.oracle.com/javase/tutorial/java/package/namingpkgs.html"},"Java Package Naming Conventions"),"."),(0,a.kt)("p",{parentName:"admonition"},"For example, the group ID ",(0,a.kt)("inlineCode",{parentName:"p"},"com.example.project")," is valid, but the group ID ",(0,a.kt)("inlineCode",{parentName:"p"},"com.example-project")," is\nnot valid.")),(0,a.kt)("h4",{id:"artifactid"},"artifactId"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"artifactId")," field modifies the project's artifact ID. This field is used to uniquely identify\na project within a group ID, and is the name of the jar without version. In multiple module\nprojects, this field is commonly used to name the individual module."),(0,a.kt)("h4",{id:"projectmainclass"},"project.main.class"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"project.main.class")," field modifies the project's main class. This field is used by the Maven\nbuild system to specify the project's main class, and is used by the application to launch the\nproject's main class."),(0,a.kt)("h2",{id:"configuring-the-documentation"},"Configuring the Documentation"),(0,a.kt)(p.ZP,{mdxType:"ConfiguringDocusaurusPartial"}),(0,a.kt)("h3",{id:"docusaurus-configuration-fields"},"Docusaurus Configuration Fields"),(0,a.kt)("h4",{id:"repoownername"},"repoOwnerName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"repoOwnerName")," field modifies the project's repository owner name. This field is used\nfor creating links used by the download button(s) and repository references in the documentation."),(0,a.kt)("h4",{id:"reponame"},"repoName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"repoName")," field modifies the project's repository name. This field is used for creating links\nused by the download button(s) and repository references in the documentation."),(0,a.kt)("h4",{id:"title"},"title"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"title")," field modifies the project's title. This field is used by the documentation to display\nthe project's title."),(0,a.kt)("h4",{id:"description"},"description"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"description")," field modifies the project's description. This field is used by the documentation\nto display the project's description on the home page."),(0,a.kt)("h4",{id:"meta"},"meta"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"meta")," field modifies the project's meta information. This field is used by the documentation\nto include meta information in the project's HTML pages, which is used by search engines and\nsocial media websites to display information about the project and/or documentation website."),(0,a.kt)("h4",{id:"configfilename"},"configFileName"),(0,a.kt)("p",null,"The ",(0,a.kt)("inlineCode",{parentName:"p"},"configFileName")," field modifies the project's configuration file name. This field is used by\nthe documentation to display the name of the configuration file used by the application."))}v.isMDXComponent=!0},6902:(e,t,i)=>{"use strict";i.d(t,{ZP:()=>c});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),s=i.n(r),l=i(4976),p=i(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function c(e){let{components:t,...i}=e;return(0,a.kt)(u,(0,n.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("em",{parentName:"p"},"File Location: ",(0,a.kt)("inlineCode",{parentName:"em"},"web-docs/ScDocusaurusConfig.js"))),(0,a.kt)("p",null,"The documentation configuration file is used to configure the documentation's title, description,\nand GitHub repository information, and must be updated before the documentation can be built."),(0,a.kt)("h3",{id:"step-1"},"Step 1"),(0,a.kt)("p",null,"Open the documentation configuration file located at ",(0,a.kt)("inlineCode",{parentName:"p"},"web-docs/ScDocusaurusConfig.js")," in your\nfavorite text editor."),(0,a.kt)("h3",{id:"step-2"},"Step 2"),(0,a.kt)("p",null,"Update the values of the following fields within the documentation configuration\nfile: ",(0,a.kt)("inlineCode",{parentName:"p"},"repoOwnerName"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"repoName"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"title"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"description"),", and ",(0,a.kt)("inlineCode",{parentName:"p"},"meta"),"."),(0,a.kt)("img",{src:l.Z,alt:"Docusaurus config file fields highlighted"}),(0,a.kt)("h3",{id:"step-3"},"Step 3"),(0,a.kt)(o.Fragment,null,"After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}c.isMDXComponent=!0},8981:(e,t,i)=>{"use strict";i.d(t,{ZP:()=>c});var n=i(7462),o=i(7294),a=i(3905),r=i(8979),s=i.n(r),l=i(9776),p=i(7873);const d={toc:[{value:"Step 1",id:"step-1",level:3},{value:"Step 2",id:"step-2",level:3},{value:"Step 3",id:"step-3",level:3}]},u="wrapper";function c(e){let{components:t,...i}=e;return(0,a.kt)(u,(0,n.Z)({},d,i,{components:t,mdxType:"MDXLayout"}),(0,a.kt)("p",null,(0,a.kt)("em",{parentName:"p"},"File Location: ",(0,a.kt)("inlineCode",{parentName:"em"},"pom.xml"))),(0,a.kt)("p",null,"The Maven POM file is used to configure the project's dependencies, build process, and\nother project settings. This includes the project's name, version, description, and main class,\nwhich must be configured before the project can be built."),(0,a.kt)("h3",{id:"step-1"},"Step 1"),(0,a.kt)("p",null,"Open the Maven POM file located at ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," in your favorite text editor."),(0,a.kt)("h3",{id:"step-2"},"Step 2"),(0,a.kt)("p",null,"Update the values of the following fields within the Maven POM\nFile: ",(0,a.kt)("inlineCode",{parentName:"p"},"name"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"version"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"groupId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"artifactId"),", ",(0,a.kt)("inlineCode",{parentName:"p"},"project.main.class"),"."),(0,a.kt)("img",{src:l.Z,alt:"Maven pom file fields highlighted"}),(0,a.kt)("h3",{id:"step-3"},"Step 3"),(0,a.kt)(o.Fragment,null,"After saving the changes to the Maven POM file, the project can be built, and you may continue setting up and using the ",s().title,"."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("img",{src:p.Z,alt:"Green check mark",width:"100"}))}c.isMDXComponent=!0},4976:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/docusaurus-update-project-info-93b51f9b35aa9d7270a537d66ff853f5.webp"},7873:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/green-check-icon-cc0v1-5747f02ee3cdf9d94fe3d8e7b48359ce.webp"},9776:(e,t,i)=>{"use strict";i.d(t,{Z:()=>n});const n=i.p+"assets/images/pom-update-project-info-1598b2441cec71969f0e3e1829f2ffb9.webp"}}]); \ No newline at end of file diff --git a/assets/js/e42a2278.b03ccba5.js b/assets/js/e42a2278.b03ccba5.js deleted file mode 100644 index 7be5f1c..0000000 --- a/assets/js/e42a2278.b03ccba5.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[408],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function a(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(o[r]=e[r]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(o[r]=e[r])}return o}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),m=o,f=d["".concat(l,".").concat(m)]||d[m]||u[m]||a;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var a=r.length,i=new Array(a);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:o,i[1]=s;for(var c=2;c{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},4266:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>y,frontMatter:()=>l,metadata:()=>p,toc:()=>u});var n=r(7462),o=r(7294),a=r(3905),i=r(8979),s=r.n(i);const l={id:"terms-of-use",title:"Terms of Use",sidebar_label:"Terms of Use"},c=void 0,p={unversionedId:"legal/terms-of-use",id:"legal/terms-of-use",title:"Terms of Use",description:"By using the {ScDocusaurusConfig.title}, you are agreeing to the following terms of",source:"@site/docs/07-legal/01-TERMS_OF_USE.mdx",sourceDirName:"07-legal",slug:"/legal/terms-of-use",permalink:"/sc-java-maven-starter-project/docs/legal/terms-of-use",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/07-legal/01-TERMS_OF_USE.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"terms-of-use",title:"Terms of Use",sidebar_label:"Terms of Use"},sidebar:"defaultSidebar",previous:{title:"Support",permalink:"/sc-java-maven-starter-project/docs/help/support"},next:{title:"Code of Conduct",permalink:"/sc-java-maven-starter-project/docs/legal/code-of-conduct"}},d={},u=[{value:"1. Conduct and Behavior",id:"1-conduct-and-behavior",level:2},{value:"2. Warranty Disclaimer",id:"2-warranty-disclaimer",level:2},{value:"3. Third-Party Content",id:"3-third-party-content",level:2},{value:"4. Trademarks",id:"4-trademarks",level:2},{value:"5. Trademark Protection",id:"5-trademark-protection",level:2}],m={toc:u},f="wrapper";function y(e){let{components:t,...r}=e;return(0,a.kt)(f,(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"By using the ",s().title,", you are agreeing to the following terms of use."),(0,a.kt)("br",null),(0,a.kt)("h2",{id:"1-conduct-and-behavior"},"1. Conduct and Behavior"),(0,a.kt)("p",null,"We expect all users of our products and services to conduct themselves in a professional and\nrespectful manner."),(0,a.kt)("p",null,"You agree to follow the ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/legal/code-of-conduct"},"Code of Conduct")," for this project."),(0,a.kt)("p",null,"You agree not to use the project for any purpose that is unlawful or prohibited by these Terms of\nUse, or any other purpose not reasonably intended by HMS, including, but not limited to, the\nfollowing:"),(0,a.kt)("ol",null,(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"In any way that breaches any applicable local, national, or international law or regulation.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"In any way that is unlawful or fraudulent, or has any unlawful or fraudulent purpose or effect.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any unsolicited or unauthorized advertising or\npromotional material or any\nother form of similar solicitation (spam).")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To knowingly transmit any data, send or upload any material that contains viruses, Trojan\nhorses, worms, time-bombs,\nkeystroke loggers, spyware, adware, or any other harmful programs or similar computer code\ndesigned to adversely\naffect the operation of any computer software or hardware.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is\ndefamatory, obscene, indecent,\nhateful, discriminatory, or inflammatory.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is\nthreatening, abusive, or\ninvades another's privacy, or causes annoyance, inconvenience, or needless anxiety.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is likely to\ndeceive any person.")),(0,a.kt)("li",{parentName:"ol"},(0,a.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that infringes any\npatent, trademark,\ntrade secret, copyright, or other intellectual property rights of any other person."))),(0,a.kt)("h2",{id:"2-warranty-disclaimer"},"2. Warranty Disclaimer"),(0,a.kt)("p",null,"We strive to provide the best products and services we can, and to provide clear, concise\ndocumentation for our users. However, we cannot guarantee that our products, services, or\ndocumentation are free from defects."),(0,a.kt)("p",null,'THE PROJECT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.\nHMS DOES NOT REPRESENT OR WARRANT THAT:\n(A) THE FUNCTIONS OF THE PROJECT WILL MEET YOUR REQUIREMENTS OR EXPECTATIONS,\n(B) THE OPERATION OF THE PROJECT WILL BE UNINTERRUPTED OR ERROR-FREE, OR\n(C) DEFECTS IN THE PROJECT CAN OR WILL BE CORRECTED.'),(0,a.kt)("h2",{id:"3-third-party-content"},"3. Third-Party Content"),(0,a.kt)("p",null,"This project may contain links to third-party websites, applications, or other content."),(0,a.kt)("p",null,"The content of any linked third-party content is not controlled by HMS, and HMS is not responsible\nfor the content of any linked third-party content. HMS does not endorse, approve, or sponsor any\nlinked third-party content, or the information, products, or services contained therein."),(0,a.kt)("p",null,"The use of any linked third-party content is at your own risk, and you will be subject to the terms\nand conditions, and privacy policies applicable to such third-party content."),(0,a.kt)("h2",{id:"4-trademarks"},"4. Trademarks"),(0,a.kt)("p",null,"Anybus\xae, Ewon\xae, Talk2M\xae and Ixxat\xae are internationally registered trademarks of HMS Industrial\nNetworks, covering the European Union, USA and other countries."),(0,a.kt)("p",null,"Intesis\xae is a registered trademark of HMS Industrial Networks in the European Union and is\ntrademarked \u2122 in the rest of the world."),(0,a.kt)("p",null,"Hardware Meets Software\u2122 is trademarked globally by HMS. Other third-party logotypes, trademarks,\nproduct or service names mentioned are the property of their respective companies and are included\non HMS websites purely for information purposes."),(0,a.kt)("h2",{id:"5-trademark-protection"},"5. Trademark Protection"),(0,a.kt)("p",null,"Any company logo or trademark is the property of the respective company. Brands and names are\nmentioned purely for information purposes."))}y.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e42a2278.f9a38d2f.js b/assets/js/e42a2278.f9a38d2f.js new file mode 100644 index 0000000..4e37e6d --- /dev/null +++ b/assets/js/e42a2278.f9a38d2f.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[408],{3905:(e,t,r)=>{"use strict";r.d(t,{Zo:()=>p,kt:()=>f});var n=r(7294);function a(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var l=n.createContext({}),c=function(e){var t=n.useContext(l),r=t;return e&&(r="function"==typeof e?e(t):i(i({},t),e)),r},p=function(e){var t=c(e.components);return n.createElement(l.Provider,{value:t},e.children)},d="mdxType",u={inlineCode:"code",wrapper:function(e){var t=e.children;return n.createElement(n.Fragment,{},t)}},m=n.forwardRef((function(e,t){var r=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),d=c(r),m=a,f=d["".concat(l,".").concat(m)]||d[m]||u[m]||o;return r?n.createElement(f,i(i({ref:t},p),{},{components:r})):n.createElement(f,i({ref:t},p))}));function f(e,t){var r=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=r.length,i=new Array(o);i[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s[d]="string"==typeof e?e:a,i[1]=s;for(var c=2;c{const t={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...t,repoUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName,repoArchiveUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+t.repoOwnerName+"/"+t.repoName+"/issues/new"}},4266:(e,t,r)=>{"use strict";r.r(t),r.d(t,{assets:()=>d,contentTitle:()=>c,default:()=>y,frontMatter:()=>l,metadata:()=>p,toc:()=>u});var n=r(7462),a=r(7294),o=r(3905),i=r(8979),s=r.n(i);const l={id:"terms-of-use",title:"Terms of Use",sidebar_label:"Terms of Use"},c=void 0,p={unversionedId:"legal/terms-of-use",id:"legal/terms-of-use",title:"Terms of Use",description:"By using the {ScDocusaurusConfig.title}, you are agreeing to the following terms of",source:"@site/docs/07-legal/01-TERMS_OF_USE.mdx",sourceDirName:"07-legal",slug:"/legal/terms-of-use",permalink:"/sc-java-maven-starter-project/docs/legal/terms-of-use",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/07-legal/01-TERMS_OF_USE.mdx",tags:[],version:"current",sidebarPosition:1,frontMatter:{id:"terms-of-use",title:"Terms of Use",sidebar_label:"Terms of Use"},sidebar:"defaultSidebar",previous:{title:"Support",permalink:"/sc-java-maven-starter-project/docs/help/support"},next:{title:"Code of Conduct",permalink:"/sc-java-maven-starter-project/docs/legal/code-of-conduct"}},d={},u=[{value:"1. Conduct and Behavior",id:"1-conduct-and-behavior",level:2},{value:"2. Warranty Disclaimer",id:"2-warranty-disclaimer",level:2},{value:"3. Third-Party Content",id:"3-third-party-content",level:2},{value:"4. Trademarks",id:"4-trademarks",level:2},{value:"5. Trademark Protection",id:"5-trademark-protection",level:2}],m={toc:u},f="wrapper";function y(e){let{components:t,...r}=e;return(0,o.kt)(f,(0,n.Z)({},m,r,{components:t,mdxType:"MDXLayout"}),(0,o.kt)(a.Fragment,null,"By using the ",s().title,", you are agreeing to the following terms of use."),(0,o.kt)("br",null),(0,o.kt)("h2",{id:"1-conduct-and-behavior"},"1. Conduct and Behavior"),(0,o.kt)("p",null,"We expect all users of our products and services to conduct themselves in a professional and\nrespectful manner."),(0,o.kt)("p",null,"You agree to follow the ",(0,o.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/legal/code-of-conduct"},"Code of Conduct")," for this project."),(0,o.kt)("p",null,"You agree not to use the project for any purpose that is unlawful or prohibited by these Terms of\nUse, or any other purpose not reasonably intended by HMS, including, but not limited to, the\nfollowing:"),(0,o.kt)("ol",null,(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"In any way that breaches any applicable local, national, or international law or regulation.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"In any way that is unlawful or fraudulent, or has any unlawful or fraudulent purpose or effect.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any unsolicited or unauthorized advertising or\npromotional material or any\nother form of similar solicitation (spam).")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To knowingly transmit any data, send or upload any material that contains viruses, Trojan\nhorses, worms, time-bombs,\nkeystroke loggers, spyware, adware, or any other harmful programs or similar computer code\ndesigned to adversely\naffect the operation of any computer software or hardware.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is\ndefamatory, obscene, indecent,\nhateful, discriminatory, or inflammatory.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is\nthreatening, abusive, or\ninvades another's privacy, or causes annoyance, inconvenience, or needless anxiety.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that is likely to\ndeceive any person.")),(0,o.kt)("li",{parentName:"ol"},(0,o.kt)("em",{parentName:"li"},"To transmit, or procure the sending of, any data, send or upload any material that infringes any\npatent, trademark,\ntrade secret, copyright, or other intellectual property rights of any other person."))),(0,o.kt)("h2",{id:"2-warranty-disclaimer"},"2. Warranty Disclaimer"),(0,o.kt)("p",null,"We strive to provide the best products and services we can, and to provide clear, concise\ndocumentation for our users. However, we cannot guarantee that our products, services, or\ndocumentation are free from defects."),(0,o.kt)("p",null,'THE PROJECT IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.\nHMS DOES NOT REPRESENT OR WARRANT THAT:\n(A) THE FUNCTIONS OF THE PROJECT WILL MEET YOUR REQUIREMENTS OR EXPECTATIONS,\n(B) THE OPERATION OF THE PROJECT WILL BE UNINTERRUPTED OR ERROR-FREE, OR\n(C) DEFECTS IN THE PROJECT CAN OR WILL BE CORRECTED.'),(0,o.kt)("h2",{id:"3-third-party-content"},"3. Third-Party Content"),(0,o.kt)("p",null,"This project may contain links to third-party websites, applications, or other content."),(0,o.kt)("p",null,"The content of any linked third-party content is not controlled by HMS, and HMS is not responsible\nfor the content of any linked third-party content. HMS does not endorse, approve, or sponsor any\nlinked third-party content, or the information, products, or services contained therein."),(0,o.kt)("p",null,"The use of any linked third-party content is at your own risk, and you will be subject to the terms\nand conditions, and privacy policies applicable to such third-party content."),(0,o.kt)("h2",{id:"4-trademarks"},"4. Trademarks"),(0,o.kt)("p",null,"Anybus\xae, Ewon\xae, Talk2M\xae and Ixxat\xae are internationally registered trademarks of HMS Industrial\nNetworks, covering the European Union, USA and other countries."),(0,o.kt)("p",null,"Intesis\xae is a registered trademark of HMS Industrial Networks in the European Union and is\ntrademarked \u2122 in the rest of the world."),(0,o.kt)("p",null,"Hardware Meets Software\u2122 is trademarked globally by HMS. Other third-party logotypes, trademarks,\nproduct or service names mentioned are the property of their respective companies and are included\non HMS websites purely for information purposes."),(0,o.kt)("h2",{id:"5-trademark-protection"},"5. Trademark Protection"),(0,o.kt)("p",null,"Any company logo or trademark is the property of the respective company. Brands and names are\nmentioned purely for information purposes."))}y.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e545b568.4f0414d0.js b/assets/js/e545b568.4f0414d0.js new file mode 100644 index 0000000..6728162 --- /dev/null +++ b/assets/js/e545b568.4f0414d0.js @@ -0,0 +1 @@ +(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[742],{3905:(e,n,t)=>{"use strict";t.d(n,{Zo:()=>p,kt:()=>v});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=r.createContext({}),d=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=d(e.components);return r.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=d(t),m=o,v=c["".concat(l,".").concat(m)]||c[m]||u[m]||a;return t?r.createElement(v,i(i({ref:n},p),{},{components:t})):r.createElement(v,i({ref:n},p))}));function v(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=m;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var d=2;d{const n={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json",applicationJarFileName:"sc-java-maven-starter-project-X.Y.Z-full.jar"};e.exports={...n,repoUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName,repoArchiveUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/issues/new"}},899:(e,n,t)=>{"use strict";t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>p,toc:()=>u});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);t(2919),t(7712),t(9958);const l={id:"libraries-and-dependencies",title:"Libraries and Dependencies",sidebar_label:"Libraries and Dependencies"},d=void 0,p={unversionedId:"developer/libraries-and-dependencies",id:"developer/libraries-and-dependencies",title:"Libraries and Dependencies",description:"Libraries and Dependencies",source:"@site/docs/08-developer/02-LIBRARIES_DEPENDENCIES.mdx",sourceDirName:"08-developer",slug:"/developer/libraries-and-dependencies",permalink:"/sc-java-maven-starter-project/docs/developer/libraries-and-dependencies",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/08-developer/02-LIBRARIES_DEPENDENCIES.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"libraries-and-dependencies",title:"Libraries and Dependencies",sidebar_label:"Libraries and Dependencies"},sidebar:"defaultSidebar",previous:{title:"Development Environment Information",permalink:"/sc-java-maven-starter-project/docs/developer/development-environment"},next:{title:"Maven Lifecycles",permalink:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles"}},c={},u=[{value:"Libraries and Dependencies",id:"libraries-and-dependencies",level:2},{value:"Adding Libraries and Dependencies",id:"adding-libraries-and-dependencies",level:3},{value:"Ewon ETK",id:"ewon-etk",level:3},{value:"Solution Center Repository",id:"solution-center-repository",level:3}],m={toc:u},v="wrapper";function h(e){let{components:n,...t}=e;return(0,a.kt)(v,(0,r.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"libraries-and-dependencies"},"Libraries and Dependencies"),(0,a.kt)(o.Fragment,null,"This ",s().title," itself does not require any libraries or dependencies. For your convenience though, the Ewon ETK is already included as a dependency."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"adding-libraries-and-dependencies"},"Adding Libraries and Dependencies"),(0,a.kt)("p",null,"As required, you can include additional libraries or dependencies using the Maven build system. To\ninclude a new library or dependency, add a new ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),". For example,"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \n commons-lang\n commons-lang\n 2.6\n \n ...\n\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"Additional libraries or dependencies must support Java 1.4, as this is the version of Java supported\nby the Ewon JTK.")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Adding dependencies may introduce warnings or errors during the Maven build process which are unable\nto be addressed in this project. These warnings and errors can typically be ignored."),(0,a.kt)("p",{parentName:"admonition"},"If you encounter Javadoc generation errors, please refer to\nthe ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/troubleshooting#3-javadoc-errors-during-build-after-updating-the-pom-file"},"Javadoc Errors During Build After Updating the POM File"),"\nsection of the ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/troubleshooting"},"Troubleshooting")," page.")),(0,a.kt)("h3",{id:"ewon-etk"},"Ewon ETK"),(0,a.kt)("p",null,"If you removed the Ewon ETK dependency, or otherwise need to re-add it, you can include it by adding\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in the ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of\nyour ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," as follows:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \n com.hms_networks.americas.sc.mvnlibs\n ewon-etk\n 1.4.4\n provided\n \n ...\n\n")),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"The scope must be set to 'provided' for the Ewon ETK. This indicates that the library is\nprovided by the system and does not need to be included in the packaged JAR file.")),(0,a.kt)("h3",{id:"solution-center-repository"},"Solution Center Repository"),(0,a.kt)("p",null,"The Ewon ETK and HMS Americas Solution Center libraries are available via the solution center\nrepository. For your convenience though, the solution center repository is already included."),(0,a.kt)("p",null,"If you removed the solution center repository, or otherwise need to re-add it, you can include it by\nadding the following ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in the ",(0,a.kt)("inlineCode",{parentName:"p"},""),"\nsection of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," as follows:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \x3c!-- HMS Networks, MU Americas Solution Center Maven Repo --\x3e\n \n sc-java-maven-repo\n HMS Networks, MU Americas Solution Center Maven Repo\n https://github.com/hms-networks/sc-java-maven-repo/raw/main/\n \n ...\n\n")))}h.isMDXComponent=!0},9958:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,a.kt)("br",null),(0,a.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,a.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,a.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,a.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}p.isMDXComponent=!0},2919:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"During the Maven ",(0,a.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,a.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,a.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,a.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,a.kt)(o.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",s().title," CI/CD pipelines.")))}p.isMDXComponent=!0},7712:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,a.kt)("br",null),(0,a.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,a.kt)(o.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",s().title,"\xa0without installing Maven directly."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,a.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/e545b568.9bfbb1f2.js b/assets/js/e545b568.9bfbb1f2.js deleted file mode 100644 index 90568a5..0000000 --- a/assets/js/e545b568.9bfbb1f2.js +++ /dev/null @@ -1 +0,0 @@ -(self.webpackChunkweb_docs=self.webpackChunkweb_docs||[]).push([[742],{3905:(e,n,t)=>{"use strict";t.d(n,{Zo:()=>p,kt:()=>v});var r=t(7294);function o(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function a(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function i(e){for(var n=1;n=0||(o[t]=e[t]);return o}(e,n);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(o[t]=e[t])}return o}var l=r.createContext({}),d=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):i(i({},n),e)),t},p=function(e){var n=d(e.components);return r.createElement(l.Provider,{value:n},e.children)},c="mdxType",u={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},m=r.forwardRef((function(e,n){var t=e.components,o=e.mdxType,a=e.originalType,l=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),c=d(t),m=o,v=c["".concat(l,".").concat(m)]||c[m]||u[m]||a;return t?r.createElement(v,i(i({ref:n},p),{},{components:t})):r.createElement(v,i({ref:n},p))}));function v(e,n){var t=arguments,o=n&&n.mdxType;if("string"==typeof e||o){var a=t.length,i=new Array(a);i[0]=m;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s[c]="string"==typeof e?e:o,i[1]=s;for(var d=2;d{const n={repoOwnerName:"hms-networks",repoName:"sc-java-maven-starter-project",title:"Solution Center Java Starter Project",description:"Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.",meta:"Homepage for the HMS Networks MU Americas Solution Center Java Starter Project.",configFileName:"ExampleConfigurationFile.json"};e.exports={...n,repoUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName,repoArchiveUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/archive/refs/heads/main.zip",repoLatestReleaseUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/releases/latest",repoNewIssueUrl:"https://github.com/"+n.repoOwnerName+"/"+n.repoName+"/issues/new"}},899:(e,n,t)=>{"use strict";t.r(n),t.d(n,{assets:()=>c,contentTitle:()=>d,default:()=>h,frontMatter:()=>l,metadata:()=>p,toc:()=>u});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);t(2919),t(7712),t(9958);const l={id:"libraries-and-dependencies",title:"Libraries and Dependencies",sidebar_label:"Libraries and Dependencies"},d=void 0,p={unversionedId:"developer/libraries-and-dependencies",id:"developer/libraries-and-dependencies",title:"Libraries and Dependencies",description:"Libraries and Dependencies",source:"@site/docs/08-developer/02-LIBRARIES_DEPENDENCIES.mdx",sourceDirName:"08-developer",slug:"/developer/libraries-and-dependencies",permalink:"/sc-java-maven-starter-project/docs/developer/libraries-and-dependencies",draft:!1,editUrl:"https://github.com/hms-networks/sc-java-maven-starter-project/docs/08-developer/02-LIBRARIES_DEPENDENCIES.mdx",tags:[],version:"current",sidebarPosition:2,frontMatter:{id:"libraries-and-dependencies",title:"Libraries and Dependencies",sidebar_label:"Libraries and Dependencies"},sidebar:"defaultSidebar",previous:{title:"Development Environment Information",permalink:"/sc-java-maven-starter-project/docs/developer/development-environment"},next:{title:"Maven Lifecycles",permalink:"/sc-java-maven-starter-project/docs/developer/maven-lifecycles"}},c={},u=[{value:"Libraries and Dependencies",id:"libraries-and-dependencies",level:2},{value:"Adding Libraries and Dependencies",id:"adding-libraries-and-dependencies",level:3},{value:"Ewon ETK",id:"ewon-etk",level:3},{value:"Solution Center Repository",id:"solution-center-repository",level:3}],m={toc:u},v="wrapper";function h(e){let{components:n,...t}=e;return(0,a.kt)(v,(0,r.Z)({},m,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)("h2",{id:"libraries-and-dependencies"},"Libraries and Dependencies"),(0,a.kt)(o.Fragment,null,"This ",s().title," itself does not require any libraries or dependencies. For your convenience though, the Ewon ETK is already included as a dependency."),(0,a.kt)("br",null),(0,a.kt)("h3",{id:"adding-libraries-and-dependencies"},"Adding Libraries and Dependencies"),(0,a.kt)("p",null,"As required, you can include additional libraries or dependencies using the Maven build system. To\ninclude a new library or dependency, add a new ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml"),". For example,"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \n commons-lang\n commons-lang\n 2.6\n \n ...\n\n")),(0,a.kt)("admonition",{type:"info"},(0,a.kt)("p",{parentName:"admonition"},"Additional libraries or dependencies must support Java 1.4, as this is the version of Java supported\nby the Ewon JTK.")),(0,a.kt)("admonition",{type:"caution"},(0,a.kt)("p",{parentName:"admonition"},"Adding dependencies may introduce warnings or errors during the Maven build process which are unable\nto be addressed in this project. These warnings and errors can typically be ignored."),(0,a.kt)("p",{parentName:"admonition"},"If you encounter Javadoc generation errors, please refer to\nthe ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/troubleshooting#3-javadoc-errors-during-build-after-updating-the-pom-file"},"Javadoc Errors During Build After Updating the POM File"),"\nsection of the ",(0,a.kt)("a",{parentName:"p",href:"/sc-java-maven-starter-project/docs/help/troubleshooting"},"Troubleshooting")," page.")),(0,a.kt)("h3",{id:"ewon-etk"},"Ewon ETK"),(0,a.kt)("p",null,"If you removed the Ewon ETK dependency, or otherwise need to re-add it, you can include it by adding\nthe ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in the ",(0,a.kt)("inlineCode",{parentName:"p"},"")," section of\nyour ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," as follows:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \n com.hms_networks.americas.sc.mvnlibs\n ewon-etk\n 1.4.4\n provided\n \n ...\n\n")),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"The scope must be set to 'provided' for the Ewon ETK. This indicates that the library is\nprovided by the system and does not need to be included in the packaged JAR file.")),(0,a.kt)("h3",{id:"solution-center-repository"},"Solution Center Repository"),(0,a.kt)("p",null,"The Ewon ETK and HMS Americas Solution Center libraries are available via the solution center\nrepository. For your convenience though, the solution center repository is already included."),(0,a.kt)("p",null,"If you removed the solution center repository, or otherwise need to re-add it, you can include it by\nadding the following ",(0,a.kt)("inlineCode",{parentName:"p"},"")," block in the ",(0,a.kt)("inlineCode",{parentName:"p"},""),"\nsection of your ",(0,a.kt)("inlineCode",{parentName:"p"},"pom.xml")," as follows:"),(0,a.kt)("pre",null,(0,a.kt)("code",{parentName:"pre",className:"language-xml"},"\n\n ...\n \x3c!-- HMS Networks, MU Americas Solution Center Maven Repo --\x3e\n \n sc-java-maven-repo\n HMS Networks, MU Americas Solution Center Maven Repo\n https://github.com/hms-networks/sc-java-maven-repo/raw/main/\n \n ...\n\n")))}h.isMDXComponent=!0},9958:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable Ewon Firmware Version",id:"installing-a-suitable-ewon-firmware-version",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported."),(0,a.kt)("br",null),(0,a.kt)("h4",{id:"installing-a-suitable-ewon-firmware-version"},"Installing a Suitable Ewon Firmware Version"),(0,a.kt)("p",null,"If you do not have a suitable Ewon firmware version installed on your system, you may download and\ninstall one from the ",(0,a.kt)("a",{parentName:"p",href:"https://www.ewon.biz/technical-support/pages/firmware"},"Ewon Support webpage"),"."),(0,a.kt)("p",null,"Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to\ninstall the firmware."))}p.isMDXComponent=!0},2919:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable JDK",id:"installing-a-suitable-jdk",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Java, and has been tested successfully with Java 16+. Older versions of Java may be compatible, but have not been tested and are not supported."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("admonition",{type:"note"},(0,a.kt)("p",{parentName:"admonition"},"During the Maven ",(0,a.kt)("a",{parentName:"p",href:"#package-lifecycle"},"package lifecycle"),", an Ewon-compatible JDK will be\nautomatically downloaded and used to compile the resulting source code. This allows for better\ncross-platform developer support, compilation consistency, and enables the use of modern Java and\nMaven environments on the host by isolating source code compilation.")),(0,a.kt)("h4",{id:"installing-a-suitable-jdk"},"Installing a Suitable JDK"),(0,a.kt)("p",null,"If you do not have a suitable JDK installed on your system, follow the vendor instructions to\ndownload and install one from the following sources:"),(0,a.kt)("ul",null,(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://aws.amazon.com/corretto/"},"Amazon Corretto (recommended)")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://bell-sw.com/pages/downloads/"},"BellSoft Liberica")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://adoptopenjdk.net/"},"AdoptOpenJDK")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://www.azul.com/downloads/zulu-community/"},"Azul Zulu")),(0,a.kt)("li",{parentName:"ul"},(0,a.kt)("a",{parentName:"li",href:"https://openjdk.java.net/"},"OpenJDK"))),(0,a.kt)("admonition",{title:"Recommended JDK",type:"tip"},(0,a.kt)(o.Fragment,null,"If you are unsure which JDK to use, we recommend using the Amazon Corretto JDK. It is free, open source, tested successfully, and is the default JDK used by the ",s().title," CI/CD pipelines.")))}p.isMDXComponent=!0},7712:(e,n,t)=>{"use strict";t.d(n,{ZP:()=>p});var r=t(7462),o=t(7294),a=t(3905),i=t(8979),s=t.n(i);const l={toc:[{value:"Installing a Suitable Maven Version",id:"installing-a-suitable-maven-version",level:4}]},d="wrapper";function p(e){let{components:n,...t}=e;return(0,a.kt)(d,(0,r.Z)({},l,t,{components:n,mdxType:"MDXLayout"}),(0,a.kt)(o.Fragment,null,"The ",s().title," has been designed to work with the latest versions of Maven, and has been tested successfully with Maven 3.6.3+. Older versions of Maven may be compatible, but have not been tested and are not supported."),(0,a.kt)("br",null),(0,a.kt)("h4",{id:"installing-a-suitable-maven-version"},"Installing a Suitable Maven Version"),(0,a.kt)(o.Fragment,null,"Many IDEs and build tools include Maven, and may be used to build the ",s().title,"\xa0without installing Maven directly."),(0,a.kt)("br",null),(0,a.kt)("br",null),(0,a.kt)("p",null,"If you do not have a suitable Maven version installed on your system, or would prefer to use Maven\nmanually, follow the vendor instructions to download and install one from\nthe ",(0,a.kt)("a",{parentName:"p",href:"https://maven.apache.org/download.cgi"},"Apache Maven webpage"),"."))}p.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.5d0e033b.js b/assets/js/runtime~main.5e5c6c91.js similarity index 94% rename from assets/js/runtime~main.5d0e033b.js rename to assets/js/runtime~main.5e5c6c91.js index 058ebe1..4f38ffc 100644 --- a/assets/js/runtime~main.5d0e033b.js +++ b/assets/js/runtime~main.5e5c6c91.js @@ -1 +1 @@ -(()=>{"use strict";var e,t,r,a,o,f={},n={};function c(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=f,c.c=n,e=[],c.O=(t,r,a,o)=>{if(!r){var f=1/0;for(b=0;b=o)&&Object.keys(c.O).every((e=>c.O[e](r[d])))?r.splice(d--,1):(n=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,c.d(o,f),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((t,r)=>(c.f[r](e,t),t)),[])),c.u=e=>"assets/js/"+({53:"935f2afb",65:"20fc1f33",208:"16085f66",237:"1df93b7f",242:"105b1668",243:"235622ac",408:"e42a2278",410:"abd378fd",470:"e21aa4c6",514:"1be78505",579:"1f6bea8b",631:"b19c86cd",655:"9737cf22",708:"c92e68d7",714:"c798ae01",742:"e545b568",773:"52e9ae15",779:"c7569f72",784:"a13fa413",796:"24d09825",896:"84b1a616",916:"fa3ee527",918:"17896441"}[e]||e)+"."+{53:"063a76d5",65:"2ce4d953",208:"35d90a9d",237:"f206fa94",242:"5b8be9d8",243:"96f3d914",408:"b03ccba5",410:"e7ad7947",470:"2ceb2bcf",473:"e2b518e0",514:"6b9d02fd",579:"d042b4dc",631:"f9186e5a",655:"bc629773",708:"a814fc04",714:"0a7f1a76",742:"9bfbb1f2",773:"ebea8962",779:"26c214f8",784:"abefbfff",796:"73412083",896:"1940a43e",916:"0b25eb90",918:"4d7127b2",972:"d3aa0c35"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="web-docs:",c.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,d;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{n.onerror=n.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),d&&document.head.appendChild(n)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/sc-java-maven-starter-project/",c.gca=function(e){return e={17896441:"918","935f2afb":"53","20fc1f33":"65","16085f66":"208","1df93b7f":"237","105b1668":"242","235622ac":"243",e42a2278:"408",abd378fd:"410",e21aa4c6:"470","1be78505":"514","1f6bea8b":"579",b19c86cd:"631","9737cf22":"655",c92e68d7:"708",c798ae01:"714",e545b568:"742","52e9ae15":"773",c7569f72:"779",a13fa413:"784","24d09825":"796","84b1a616":"896",fa3ee527:"916"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=c.p+c.u(t),n=new Error;c.l(f,(r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],d=r[2],i=0;if(f.some((t=>0!==e[t]))){for(a in n)c.o(n,a)&&(c.m[a]=n[a]);if(d)var b=d(c)}for(t&&t(r);i{"use strict";var e,t,r,a,o,f={},n={};function c(e){var t=n[e];if(void 0!==t)return t.exports;var r=n[e]={id:e,loaded:!1,exports:{}};return f[e].call(r.exports,r,r.exports,c),r.loaded=!0,r.exports}c.m=f,c.c=n,e=[],c.O=(t,r,a,o)=>{if(!r){var f=1/0;for(b=0;b=o)&&Object.keys(c.O).every((e=>c.O[e](r[d])))?r.splice(d--,1):(n=!1,o0&&e[b-1][2]>o;b--)e[b]=e[b-1];e[b]=[r,a,o]},c.n=e=>{var t=e&&e.__esModule?()=>e.default:()=>e;return c.d(t,{a:t}),t},r=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,c.t=function(e,a){if(1&a&&(e=this(e)),8&a)return e;if("object"==typeof e&&e){if(4&a&&e.__esModule)return e;if(16&a&&"function"==typeof e.then)return e}var o=Object.create(null);c.r(o);var f={};t=t||[null,r({}),r([]),r(r)];for(var n=2&a&&e;"object"==typeof n&&!~t.indexOf(n);n=r(n))Object.getOwnPropertyNames(n).forEach((t=>f[t]=()=>e[t]));return f.default=()=>e,c.d(o,f),o},c.d=(e,t)=>{for(var r in t)c.o(t,r)&&!c.o(e,r)&&Object.defineProperty(e,r,{enumerable:!0,get:t[r]})},c.f={},c.e=e=>Promise.all(Object.keys(c.f).reduce(((t,r)=>(c.f[r](e,t),t)),[])),c.u=e=>"assets/js/"+({53:"935f2afb",65:"20fc1f33",208:"16085f66",237:"1df93b7f",242:"105b1668",243:"235622ac",408:"e42a2278",410:"abd378fd",470:"e21aa4c6",514:"1be78505",579:"1f6bea8b",631:"b19c86cd",655:"9737cf22",708:"c92e68d7",714:"c798ae01",742:"e545b568",773:"52e9ae15",779:"c7569f72",784:"a13fa413",796:"24d09825",896:"84b1a616",916:"fa3ee527",918:"17896441"}[e]||e)+"."+{53:"063a76d5",65:"2ce4d953",208:"35d90a9d",237:"17de39b0",242:"42a712dc",243:"0c1f6eca",408:"f9a38d2f",410:"4d7693b1",470:"2ceb2bcf",473:"e2b518e0",514:"6b9d02fd",579:"33d55812",631:"d5976f25",655:"f4957510",708:"9ad16975",714:"9eae191b",742:"4f0414d0",773:"ebea8962",779:"9e16e70f",784:"abefbfff",796:"73412083",896:"1940a43e",916:"0b25eb90",918:"4d7127b2",972:"d3aa0c35"}[e]+".js",c.miniCssF=e=>{},c.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),c.o=(e,t)=>Object.prototype.hasOwnProperty.call(e,t),a={},o="web-docs:",c.l=(e,t,r,f)=>{if(a[e])a[e].push(t);else{var n,d;if(void 0!==r)for(var i=document.getElementsByTagName("script"),b=0;b{n.onerror=n.onload=null,clearTimeout(s);var o=a[e];if(delete a[e],n.parentNode&&n.parentNode.removeChild(n),o&&o.forEach((e=>e(r))),t)return t(r)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:n}),12e4);n.onerror=l.bind(null,n.onerror),n.onload=l.bind(null,n.onload),d&&document.head.appendChild(n)}},c.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},c.p="/sc-java-maven-starter-project/",c.gca=function(e){return e={17896441:"918","935f2afb":"53","20fc1f33":"65","16085f66":"208","1df93b7f":"237","105b1668":"242","235622ac":"243",e42a2278:"408",abd378fd:"410",e21aa4c6:"470","1be78505":"514","1f6bea8b":"579",b19c86cd:"631","9737cf22":"655",c92e68d7:"708",c798ae01:"714",e545b568:"742","52e9ae15":"773",c7569f72:"779",a13fa413:"784","24d09825":"796","84b1a616":"896",fa3ee527:"916"}[e]||e,c.p+c.u(e)},(()=>{var e={303:0,532:0};c.f.j=(t,r)=>{var a=c.o(e,t)?e[t]:void 0;if(0!==a)if(a)r.push(a[2]);else if(/^(303|532)$/.test(t))e[t]=0;else{var o=new Promise(((r,o)=>a=e[t]=[r,o]));r.push(a[2]=o);var f=c.p+c.u(t),n=new Error;c.l(f,(r=>{if(c.o(e,t)&&(0!==(a=e[t])&&(e[t]=void 0),a)){var o=r&&("load"===r.type?"missing":r.type),f=r&&r.target&&r.target.src;n.message="Loading chunk "+t+" failed.\n("+o+": "+f+")",n.name="ChunkLoadError",n.type=o,n.request=f,a[1](n)}}),"chunk-"+t,t)}},c.O.j=t=>0===e[t];var t=(t,r)=>{var a,o,f=r[0],n=r[1],d=r[2],i=0;if(f.some((t=>0!==e[t]))){for(a in n)c.o(n,a)&&(c.m[a]=n[a]);if(d)var b=d(c)}for(t&&t(r);i Introduction | Solution Center Java Starter Project - + @@ -19,7 +19,7 @@ tested and may require additional configuration and/or plugins.

Improves documentation experience​

  • Open-source, Docusaurus-based documentation platform
  • Richer, more modern documentation
  • Easy to use and navigate
  • Easy to maintain

License​

This project is licensed under the terms of the Apache 2.0 license. More information about the license and the full text of the license, can be found on the LICENSE page.

- + \ No newline at end of file diff --git a/docs/change-log.html b/docs/change-log.html index e5e6a93..3a7aa32 100644 --- a/docs/change-log.html +++ b/docs/change-log.html @@ -4,14 +4,14 @@ Change Log | Solution Center Java Starter Project - +
-

Change Log

Version X.Y.Z​

Features​

  • Added configFileName to ScDocusaurusConfig.js
    • Documentation now has access to refrence the config file name as a configurable parameter

Version 0.0.5​

Features​

  • Added Checkstyle configuration for code style and formatting enforcement
    • Integrated Checkstyle into Maven build process

Bug Fixes​

  • Fixed incorrect version number in commit-format-check.yml GitHub Actions workflow

Version 0.0.4​

Features​

  • Javadoc warnings now trigger build failure to ensure documentation quality

Version 0.0.3​

Features​

  • Improved code style and formatting configurations for IntelliJ and Eclipse IDEs
    • Added IDE code style configuration information to documentation
  • Added a Popover component for web documentation, popover.js
  • Added a Highlight component for web documentation, highlight.js

Bug Fixes​

  • Fixed VS Code tasks.json Maven commands
  • Standardized newlines in documentation
  • Corrected default debugger IP addresses in IDE configuration files to match the default in +

    Change Log

    Version X.Y.Z​

    Features​

    • Added configFileName to ScDocusaurusConfig.js
      • Documentation now has access to reference the config file name as a configurable parameter
    • Added applicationJarFileName to ScDocusaurusConfig.js
      • Documentation now has access to reference the generated JAR file name as a configurable parameter

    Version 0.0.5​

    Features​

    • Added Checkstyle configuration for code style and formatting enforcement
      • Integrated Checkstyle into Maven build process

    Bug Fixes​

    • Fixed incorrect version number in commit-format-check.yml GitHub Actions workflow

    Version 0.0.4​

    Features​

    • Javadoc warnings now trigger build failure to ensure documentation quality

    Version 0.0.3​

    Features​

    • Improved code style and formatting configurations for IntelliJ and Eclipse IDEs
      • Added IDE code style configuration information to documentation
    • Added a Popover component for web documentation, popover.js
    • Added a Highlight component for web documentation, highlight.js

    Bug Fixes​

    • Fixed VS Code tasks.json Maven commands
    • Standardized newlines in documentation
    • Corrected default debugger IP addresses in IDE configuration files to match the default in the flexy.properties file
    • Fixed missing Jar file in artifacts from release-build-outputs.yml GitHub Actions workflow

    Other​

    • Updated IntelliJ IDE configuration files to latest formats
    • Organized Eclipse IDE configuration files under .eclipse directory

    Version 0.0.2​

    Features​

    • Added example configuration file
    • Added external Flexy properties file
    • Added jvmrun file autofill from pom.xml
    • Improved documentation and migrated to Docusaurus
    • Improved GitHub Actions workflows
      • Added jvmrun file line-ending normalization
      • Updated to latest plugin/action versions to resolve warnings

    Bug Fixes​

    • Resolved warnings due to deprecation of utilized GitHub Actions dependencies
    • Removed the stray/trailing NUL character from release bodies

    Other​

    • Excluded Ewon ETK from generated Javadocs

    Version 0.0.1​

    Features​

    • Initial Release

    Bug Fixes​

    • N/A

    Other​

    • N/A
- + \ No newline at end of file diff --git a/docs/developer/contribution-guidelines.html b/docs/developer/contribution-guidelines.html index a577cf4..cd2c857 100644 --- a/docs/developer/contribution-guidelines.html +++ b/docs/developer/contribution-guidelines.html @@ -4,13 +4,13 @@ Contribution Guidelines | Solution Center Java Starter Project - +

Contribution Guidelines

Solution Center Java Maven Starter Project Contribution Guidelines

Thank you for your interest in contributing to the project.

All types of contributions are valued and encouraged, though there are a few guidelines which must be followed to make the contribution process easy and consistent. See the Table of Contents for different ways to help and details about how this project handles them.

If you like the project, but don't have time to contribute, there are other easy ways to show your support and appreciation, such as:

  • Star the project
  • Refer to this project in another project
  • Mention or share the project at local meetups and tell your colleagues

Table of Contents​

Code of Conduct​

This project and everyone who participates in it is governed by the project's Code of Conduct.

By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainer(s).

Asking Questions​

Before asking a question, it is best to search for existing Issues or Discussions that may help. In case you've found a suitable issue or discussion and still need clarification, you may comment directly on the issue or discussion. It is also advisable to search the internet for answers.

If you then still have a question or need clarification, you may create a new discussion or new issue and provide as much context and detail as possible.

How To Contribute​

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.

Reporting Bugs and Errors​

We use GitHub issues to track bugs and errors. If you run into an issue with the project, please create a new issue with the following in consideration:

  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. If possible, please isolate the problem and create a test case.

Once you have submitted an issue on GitHub, we will label it and follow-up accordingly.

Suggesting Features or Enhancements​

We use GitHub issues to track feature and enhancement requests. If you'd like to suggest a feature or enhancement, please create a new issue with the following in consideration:

  • Make sure that you are using the latest version.
  • Make sure that you are using the latest Ewon firmware.
  • Read the Documentation carefully to find out if the functionality is already covered.
  • Perform a search for existing Issues or Discussions to see if the feature or enhancement has already been suggested.
    • If the feature or enhancement has already been suggested, add a comment to the existing issue or discussion instead of opening a new one.
  • Make sure the feature or enhancement is with the scope and aims of the project. New features shall be useful to the majority of users, not a small subset.
    • If a feature or enhancement targets a minority of users, it is advised to consider writing an add-on or library.

Making Modifications or Updates​

The development environment for this project uses the standard Ewon Java development environment, which is Eclipse. Alternative IDEs can be used but may not be fully compatible with the Ewon Java Toolkit and thus are not guaranteed nor officially supported by HMS.

Documentation and additional information about the Ewon Java development environment is available in the Ewon Java Toolkit User Guide (J2SE) at https://developer.ewon.biz/content/java-0#dev-documents.

Documentation​

Changes made to the documentation in this project must be made in an individual commit, or accompany the commit with the relevant source code changes.

Documentation for this project shall be written in present passive voice and is governed by the project's Code of Conduct.

Source Code​

Changes made to the source code in this project must be organized into individual commits, each with an individual objective.

Source code in this project adheres to the Google Java Style Guide, and any changes must follow the same format. Detailed information about the Google Java Style Guide can be found at https://google.github.io/styleguide/javaguide.html.

Source code changes which do not adhere to the Google Java Style Guide will be rejected automatically during the pull request phase.

Committing and Merging Modifications and Updates​

Commit Scope​

Each commit to this project should have very limited scope. All changes in each commit should have a common theme, and you should be able to describe the scope of the change as a single statement. Hint: If you can not describe the commit without using the word "and" or creating a list, the commit should be broken up.

To ensure a clean and productive Git history, commits which do not follow those guidelines should be reorganized, otherwise they may be rejected during the pull request phase.

Commit Messages​

Each commit must contain a message describing the change(s) made. The commit message must meet the following guidelines:

  1. Subject (First Line)
    1. Must not be more than 50 characters in length
    2. Must describe commit change-set concisely
    3. Must capitalize first character
    4. Must not end with a period
    5. Must be followed by a blank line (unless body omitted)
  2. Body
    1. Must not be more than 72 characters in length, per line
    2. Must describe commit change-set thoroughly
    3. Must use proper capitalization, grammar, and punctuation
    4. Must use blank lines to separate paragraphs
Subject line

More detailed explanatory text, if necessary. Wrap to 72 characters
or less. The blank line between the subject line and commit body is
critical (unless commit body is omitted).

Additional paragraphs can be added after another blank line. Bullet
points and other rich text can be included as well.

1. Example Change
2. Example Addition
3. Example Bug Fix

Pull Requests​

All code committed to this project must follow the pull request procedure before it can be merged to the main or master branch. The pull request procedure ensures that all changes have been reviewed by a project maintainer, and tested to function properly.

In addition to any automated testing which may be performed for pull requests, all modified or newly-introduced code must be thoroughly tested prior to creating a pull request.

Once a pull request has been created, the following must be performed:

  1. Designate pull request assignee
    • Under most circumstances, the person creating the pull request shall be designated as the assignee. Should another person become responsible for the pull request, that person shall be designated as the assignee.
  2. Add content labels
    • Pull requests and other GitHub content can be labeled to document the type of content addressed. These labels can be found and assigned in the pull request sidebar.
  3. Add linked issues
    • If the pull request resolves or otherwise addresses an issue documented using GitHub Issues, the issue should be linked to the pull request. Linked issues can be found and assigned in the pull request sidebar.
  4. Add pull request reviewers
    • Pull requests must be reviewed by at least one, but preferably two, reviewers or code-owners. These reviewers should be chosen based on project familiarity, code language, and dependencies. In some scenarios, a code-owner may automatically be assigned to a pull request.
- + \ No newline at end of file diff --git a/docs/developer/development-environment.html b/docs/developer/development-environment.html index 39f2d2e..91676c8 100644 --- a/docs/developer/development-environment.html +++ b/docs/developer/development-environment.html @@ -4,7 +4,7 @@ Development Environment Information | Solution Center Java Starter Project - + @@ -43,7 +43,7 @@ to https://developer.ewon.biz/content/java-0.

note

This project does not interact with the build.xml Ant build file, or the Ant build system. Therefore, it is possible to use the official Ewon-supplied build.xml Ant build file in conjunction with the supplied pom.xml Maven build file.

- + \ No newline at end of file diff --git a/docs/developer/libraries-and-dependencies.html b/docs/developer/libraries-and-dependencies.html index 0b7a97d..bc7ded7 100644 --- a/docs/developer/libraries-and-dependencies.html +++ b/docs/developer/libraries-and-dependencies.html @@ -4,7 +4,7 @@ Libraries and Dependencies | Solution Center Java Starter Project - + @@ -22,7 +22,7 @@ repository. For your convenience though, the solution center repository is already included.

If you removed the solution center repository, or otherwise need to re-add it, you can include it by adding the following <repository></repository> block in the <repositories></repositories> section of your pom.xml as follows:


<repositories>
  ...
  <!-- HMS Networks, MU Americas Solution Center Maven Repo -->
  <repository>
    <id>sc-java-maven-repo</id>
    <name>HMS Networks, MU Americas Solution Center Maven Repo</name>
    <url>https://github.com/hms-networks/sc-java-maven-repo/raw/main/</url>
  </repository>
  ...
</repositories>
- + \ No newline at end of file diff --git a/docs/developer/maven-lifecycles.html b/docs/developer/maven-lifecycles.html index d686926..50663d7 100644 --- a/docs/developer/maven-lifecycles.html +++ b/docs/developer/maven-lifecycles.html @@ -4,7 +4,7 @@ Maven Lifecycles | Solution Center Java Starter Project - + @@ -36,7 +36,7 @@ debugging connection must be manually created using the values from the 'ewon.address' and ' project.build.debug.port' properties. The following command will run the deploy lifecycle with debugging enabled:

mvn deploy -f pom.xml -P debug
- + \ No newline at end of file diff --git a/docs/help/faq.html b/docs/help/faq.html index 4b345f5..5099dab 100644 --- a/docs/help/faq.html +++ b/docs/help/faq.html @@ -4,7 +4,7 @@ Frequently Asked Questions | Solution Center Java Starter Project - + @@ -23,7 +23,7 @@ into your project.

2. Where can I learn more about Docusaurus?​

Docusaurus is a static site generator that is used to build the documentation for the Solution Center Java Starter Project.

Additional information about Docusaurus can be found on the Docusaurus website, https://docusaurus.io/.

3. Where can I learn more about Maven?​

Maven is the build automation tool that is used to build the Java application and associated dependencies for the Solution Center Java Starter Project.

Additional information about Maven can be found on the Maven website, https://maven.apache.org/.

- + \ No newline at end of file diff --git a/docs/help/support.html b/docs/help/support.html index bebbde1..0c1b24c 100644 --- a/docs/help/support.html +++ b/docs/help/support.html @@ -4,7 +4,7 @@ Support | Solution Center Java Starter Project - + @@ -15,7 +15,7 @@ Ewon-supplied build.xml Ant build file, please refer to https://developer.ewon.biz/content/java-0.

The Solution Center Java Starter Project is supported by the HMS Networks North American Offices.

GitHub Issues​

For concerns regarding the functionality and features of the Solution Center Java Starter Project, please create an issue using the "Issues" tab on the GitHub repository page.

HMS Networks Support Portal​

For all other inquiries, please use the HMS Networks Support Portal.

- + \ No newline at end of file diff --git a/docs/help/troubleshooting.html b/docs/help/troubleshooting.html index e7ff88e..50d6520 100644 --- a/docs/help/troubleshooting.html +++ b/docs/help/troubleshooting.html @@ -4,7 +4,7 @@ Troubleshooting | Solution Center Java Starter Project - + @@ -31,7 +31,7 @@ the org.apache.maven.plugins:maven-javadoc-plugin <plugin></plugin> section of your pom.xml.

info

For example, to exclude the Javadoc documentation for the commons-lang:commons-lang dependency, add the following to the org.apache.maven.plugins:maven-javadoc-plugin <plugin></plugin> section of your pom.xml:


<dependencySourceExclude>commons-lang:commons-lang:*</dependencySourceExclude>
- + \ No newline at end of file diff --git a/docs/legal/code-of-conduct.html b/docs/legal/code-of-conduct.html index 679669a..07abdd8 100644 --- a/docs/legal/code-of-conduct.html +++ b/docs/legal/code-of-conduct.html @@ -4,7 +4,7 @@ Code of Conduct | Solution Center Java Starter Project - + @@ -59,7 +59,7 @@ Mozilla's code of conduct enforcement ladder.

For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

- + \ No newline at end of file diff --git a/docs/legal/license.html b/docs/legal/license.html index 941d633..4835779 100644 --- a/docs/legal/license.html +++ b/docs/legal/license.html @@ -4,13 +4,13 @@ License | Solution Center Java Starter Project - +

License

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   Copyright 2019 HMS Networks Inc.

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
- + \ No newline at end of file diff --git a/docs/legal/terms-of-use.html b/docs/legal/terms-of-use.html index 5e56153..d39ddb7 100644 --- a/docs/legal/terms-of-use.html +++ b/docs/legal/terms-of-use.html @@ -4,7 +4,7 @@ Terms of Use | Solution Center Java Starter Project - + @@ -40,7 +40,7 @@ product or service names mentioned are the property of their respective companies and are included on HMS websites purely for information purposes.

5. Trademark Protection​

Any company logo or trademark is the property of the respective company. Brands and names are mentioned purely for information purposes.

- + \ No newline at end of file diff --git a/docs/quick-start-guide.html b/docs/quick-start-guide.html index 29f205d..96ad49a 100644 --- a/docs/quick-start-guide.html +++ b/docs/quick-start-guide.html @@ -4,7 +4,7 @@ Quick Start Guide | Solution Center Java Starter Project - + @@ -24,7 +24,7 @@ favorite text editor.

Step 2​

Update the values of the following fields within the documentation configuration file: repoOwnerName, repoName, title, description, and meta.

Docusaurus config file fields highlighted

Step 3​

After saving the changes to the documentation configuration file, the documentation can be built, and you may continue setting up and using the Solution Center Java Starter Project.

Green check mark

NOTE​

Additional information about the Docusaurus configuration file and its fields can be found on the Configuration page.

- + \ No newline at end of file diff --git a/docs/setup/configuration.html b/docs/setup/configuration.html index 0b96f72..d1998c3 100644 --- a/docs/setup/configuration.html +++ b/docs/setup/configuration.html @@ -4,7 +4,7 @@ Configuration | Solution Center Java Starter Project - + @@ -32,8 +32,9 @@ to display the project's description on the home page.

meta​

The meta field modifies the project's meta information. This field is used by the documentation to include meta information in the project's HTML pages, which is used by search engines and social media websites to display information about the project and/or documentation website.

configFileName​

The configFileName field modifies the project's configuration file name. This field is used by -the documentation to display the name of the configuration file used by the application.

- +the documentation to display the name of the configuration file used by the application.

applicationJarFileName​

The applicationJarFileName field modifies the project's application JAR file name. This field is +used by the documentation to display the name of the JAR file used by the application.

+ \ No newline at end of file diff --git a/docs/setup/using-template.html b/docs/setup/using-template.html index 90958ac..8b6b991 100644 --- a/docs/setup/using-template.html +++ b/docs/setup/using-template.html @@ -4,7 +4,7 @@ Using Template | Solution Center Java Starter Project - + @@ -20,7 +20,7 @@ page.

Alternatively, you may download the template from the GitHub repository archive.

GitHub code button menu download zip option

Step 2​

After the ZIP file has downloaded, extract the contents to a new directory on your local machine.

If you wish to use the template as a new repository, you may create a new repository from the extracted contents. Otherwise, you may copy the contents to an existing repository.

GitHub downloaded zip extraction

Step 3​

Once the downloaded ZIP file has been extracted, you may begin using the Solution Center Java Starter Project. Additional documentation may be found in the menu to the left (above on mobile).

Green check mark
- + \ No newline at end of file diff --git a/docs/usage/features.html b/docs/usage/features.html index 4a80065..9b73e35 100644 --- a/docs/usage/features.html +++ b/docs/usage/features.html @@ -4,7 +4,7 @@ Features | Solution Center Java Starter Project - + @@ -12,7 +12,7 @@

Features

Adds Apache Maven for build management​

  • Improved dependency management
  • More consistent build process
  • Cleaner project structure
tip

A supported JDK is automatically downloaded and used by Maven for Ewon ETK builds. The downloaded JDK is not installed on the system and is only used by Maven for Ewon ETK builds.

Simplifies developer setup​

  • OS-independent
  • No need to install the Ewon ETK or other dependencies
  • No requirement for an older, specific version of Java

Extends Ewon JTK development to more IDEs​

info

Any IDE that supports Maven projects may be used. IDEs which are not listed above have not been tested and may require additional configuration and/or plugins.

Improves documentation experience​

  • Open-source, Docusaurus-based documentation platform
  • Richer, more modern documentation
  • Easy to use and navigate
  • Easy to maintain
- + \ No newline at end of file diff --git a/docs/usage/system-requirements.html b/docs/usage/system-requirements.html index ba44ddb..8661e68 100644 --- a/docs/usage/system-requirements.html +++ b/docs/usage/system-requirements.html @@ -4,7 +4,7 @@ System Requirements | Solution Center Java Starter Project - + @@ -18,7 +18,7 @@ the Apache Maven webpage.

Required Ewon Firmware Version​

The Solution Center Java Starter Project requires a minimum Ewon firmware version of 14.6 or higher. Older firmware versions may be incompatible and are not supported.

Installing a Suitable Ewon Firmware Version​

If you do not have a suitable Ewon firmware version installed on your system, you may download and install one from the Ewon Support webpage.

Follow the instructions provided on the Ewon Support webpage for your specific Ewon device to install the firmware.

- + \ No newline at end of file diff --git a/index.html b/index.html index 6b45f8f..9aebdee 100644 --- a/index.html +++ b/index.html @@ -4,13 +4,13 @@ Home | Solution Center Java Starter Project - +

Solution Center Java Starter Project

Kick off Java development on the Ewon Flexy with the HMS Networks Solution Center Java Starter Project.


DocumentationQuick Start GuideDownloadSource Code

Harness the power of your industrial machines

The Ewon Flexy is able to perform data acquisition with the following protocols: Modbus RTU, Modbus TCP, Uni-Telway, EtherNet/IP, DF1, FINS TCP, FINS Hostlink, ISO TCP, PPI, MPI, Profibus, Mitsubishi FX, Hitachi EH, ASCII.

Easy Connections to Cloud Platforms!

You can connect your Flexy to different clouds, including Talk2M Direct connection to Azure IoT Hub (Microsoft) and AWS IoT (Amazon) are also possible, even if you want to use Talk2M, our Flexy is certified to connect to these other clouds.

Leverage the power of the Solution Center Java Starter Project to gain productivity insights

With your machine data connected via the Solution Center Java Starter Project, you can now make use of the vast collection of features and modules to gain productivity insights, control your factory floor, and much more!

- + \ No newline at end of file