Develop to Main - Typo (#16)

* Update CI for mkdocs * Remove Auto-ref plugin * Update with Images * Create __init__ * Upload blog images * Create __init__ * Add files via upload * Remove inits * Update with Release * Update for type in env file * Update env to set java config for pyspark * Update to env jdk * Update documentation with Fleming Typo
sede-open · Nov 22, 2024 · 65d8cf6 · 65d8cf6
1 parent 636c9ba
commit 65d8cf6
Show file tree

Hide file tree

Showing 5 changed files with 90 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Fleming
 
-A proposed open-source project of the "brain" of the AI Discovery Tool. Including techincal scripts to build, register, serve and query models on databricks which use Semantic Search. These models can be run on cpu and not gpu providing signiifcant cost reductions.
+An open-source project of the "brain" of the AI Discovery Tool. Including techincal scripts to build, register, serve and query models on databricks which use Semantic Search. These models can be run on cpu and not gpu providing signiifcant cost reductions.
 
 Databricks, a popular big data processing and analytics platform, is utilized to build and train machine learning models on the ingested data.
 
@@ -165,14 +165,13 @@ except requests.exceptions.HTTPError as e:
 |------------------|-----------------------------------------------------------------------------------------|
 |`setup.py`        | Set up requirements for python package deployment                                       |
 |`environment.yml` | yml file to create an environment with all the dependencies for developers              |
-|`CODE_OF_CONDUCT` | code of conduct                                                                         |
-|`CODEOWNERS`      | codeowners                                                                              |
-|`CONTRIBUTING.yml`| contributing                                                                            |
-|`GOVERNANCE.yml`  | governance                                                                              |
-|`LICENSE.yml`     | license                                                                                 |
-|`RELEASE.yml`     | releases                                                                                |
-|`SUPPORT.yml`     | support                                                                                 |
-|`README.yml`      |  read me documentation                                                             |
+|`CODE_OF_CONDUCT.md` | code of conduct                                                                         |
+|`CODEOWNERS.md`      | codeowners                                                                              |
+|`CONTRIBUTING.md`| contributing                                                                            |
+|`LICENSE`     | license                                                                                 |
+|`RELEASE.md`     | releases                                                                                |
+|`SUPPORT.md`     | support                                                                                 |
+|`README.md`      |  read me documentation                                                             |
 |`.gitignore`      | Informs Git which files to ignore when committing your project to the GitHub repository |
 
 # Developer Guide - How to Use
@@ -181,7 +180,7 @@ except requests.exceptions.HTTPError as e:
 
 1) To get started with developing for this project, clone the repository. 
 ```
-    git clone https://github.com/sede-x/Flemming.git.
+    git clone https://github.com/sede-open/Fleming.git
 ```
 2) Open the respository in VS Code, Visual Studio or your preferered code editor.
 
@@ -197,7 +196,7 @@ except requests.exceptions.HTTPError as e:
 ```
     micromamba activate 
 ```
-You are now ready to start developing your own functions. Please remember to follow Felmming's development lifecycle to maintain clarity and efficiency for a fully robust self serving platform. 
+You are now ready to start developing your own functions. Please remember to follow Felming's development lifecycle to maintain clarity and efficiency for a fully robust self serving platform. 
 
 5) For better readability of code is would be useful to enable black and isort on autosave by simply adding this to the VSCode user settings json(Ctrl + Shft + P):
 
@@ -233,7 +232,7 @@ You are now ready to start developing your own functions. Please remember to fol
 > **_NOTE:_**  Ensure you have read the [Release Guidelines](RELEASE.md) before publishing your code.
 
 # Support and contacts
-If you encounter any issues or have questions, please reach out to the Innersource-Enablement-Team. They will be happy to assist you and provide further information about the project.
+If you encounter any issues or have questions, please reach out to the team by raising an issue on the repo. They will be happy to assist you and provide further information about the project.
 
 # Contributing
 Contributions to this project are welcome! If you would like to contribute, please refer to our [Contributing Guide](CONTRIBUTION.md) for guidelines on how to get started. We appreciate your support in making this project even better.

diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,68 @@
+# RELEASES
+
+## Release policy
+
+We strive to improve the repo and fix known issues.
+
+## Checklist
+
+This checklist guides you through preparing, testing and documenting a release.
+
+```
+Please ensure to SQUASH MERGE to DEVELOP and MERGE to MAIN
+```
+
+###  Squash Merging a Pull Request into Develop
+
+- [ ] Update your current branch with your work
+    - [ ] Decide which commits you want to push to your branch.
+    - [ ] Update dependencies.
+    - [ ] Ensure tests have been ran and passed.
+    - [ ] Check whether documentation has been updated and is relevant to any new functionalities.
+    - [ ] Commit & push
+        - local changes (e.g. from the change log updates): `git commit -am "..."`
+        - `git push`
+
+- [ ] Create a Pull Request
+    - [ ] Provide an appropriate title for your pull request.
+    - [ ] Choose a REVIEWER from the [Code Owners List](./CODEOWNERS.md).
+    - [ ] Use appropriate labels on your pull request, under Labels on the right hand side.
+    - [ ] If necessary link issues into your pull request by selecting an ID under Development on the right hand side.
+    - [ ] Check whether all tests have passed and that Sonarcloud has not flagged any issues. If there are any issues please make the changes on your branch.
+
+- [ ] Review and Approve a Pull Request
+    - [ ] The REVIEWER must review the code and ask questions/comment where appropriate.
+    - [ ] Before the REVIEWER can squash merge into Develop all comments/questions should be closed and all checks must be passed.
+    - [ ] The REVIEWER  who approves the request must do a __SQUASH MERGE__ into Develop.
+
+### Merging Develop to Main
+
+- [ ] Create a Pull Request from Develop to Main
+    - [ ] Provide the the version number ie. vX.X.X as the title.
+    - [ ] Choose two REVIEWERs from the [Code Owners List](./CODEOWNERS.md), under Reviewers on the right hand side.
+    - [ ] Check whether all tests have passed and that Sonarcloud has not flagged any issues. If there are any issues you will not be able to merge.
+
+- [ ] Review and Approve a Pull Request
+    - [ ] The REVIEWERs must ensure that the only changes into Main are coming from Develop.
+    - [ ] The REVIEWER must review the code and ask questions/comment where appropriate.
+    - [ ] Before the REVIEWER can  merge into Main all comments/questions should be closed and all checks must be passed.
+    - [ ] The REVIEWERs who approves the request must __MERGE__ into Main.
+
+### Creating a New Release from Main
+
+- [ ] Verify you have successfully merged into Main 
+
+- [ ] Create a New Realease
+    - [ ] Click on the _Release_ tab on the right hand side of the repository.
+    - [ ] Click on the _Draft a new release_ button
+    - [ ] Provide an appropriate Tag Name, please use the version number ie. vX.X.X
+    - [ ] Select main as the Target
+    - [ ] Provide an appropriate Title, please use the version number ie. vX.X.X
+    - [ ] Click the _Generate release notes_ button.
+    - [ ] Verify the Notes.
+    - [ ] Tick the  _Set as the latest release_ option.
+    - [ ] Create your release by clicking the  _Publish release_ button.
+
+- [ ] Verify the Release is Successful
+    - [ ] If the release has failed troubleshoot the issue and re run the job.
+    - [ ] Mention the release on suitable social media accounts.
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
@@ -2,7 +2,7 @@
 
 1) To get started with developing for this project, clone the repository. 
 ```
-    git clone https://github.com/sede-x/Flemming.git
+    git clone https://github.com/sede-open/Fleming.git
 ```
 2) Open the respository in VS Code, Visual Studio or your preferered code editor.
 
@@ -18,7 +18,7 @@
 ```
     micromamba activate 
 ```
-You are now ready to start developing your own functions. Please remember to follow Felmming's development lifecycle to maintain clarity and efficiency for a fully robust self serving platform. 
+You are now ready to start developing your own functions. Please remember to follow Felming's development lifecycle to maintain clarity and efficiency for a fully robust self serving platform. 
 
 5) For better readability of code is would be useful to enable black and isort on autosave by simply adding this to the VSCode user settings json(Ctrl + Shft + P):
 

diff --git a/docs/releases/fleming.md b/docs/releases/fleming.md
@@ -1,5 +1,12 @@
 # Releases 
 
+# V0.0.2
+
+## What's Changed
+* Env Bug Fix with JDK by @Amber-Rigg in https://github.com/sede-open/Fleming/pull/11
+
+**Full Changelog**: https://github.com/sede-open/Fleming/compare/v0.0.1...v0.0.2
+
 # V0.0.1
 
 ## What's Changed

diff --git a/environment.yml b/environment.yml
@@ -32,8 +32,8 @@ dependencies:
     - mkdocs-macros-plugin==1.0.1
     - openjdk=11
     - pip:
-        - databricks-sdk>=0.20.0,<1.0.0 
+        - databricks-sdk>=0.20.0,<1.0.0
         - torch>=2.4.1
         - pyspark>=3.3.0,<3.6.0
         - sentence-transformers>=3.2.0
-        - mlflow>=2.0.1
+        - mlflow>=2.0.1