From 66be40ea7f6b3fcaca11264b7b75de358e9cb4b9 Mon Sep 17 00:00:00 2001 From: Wesley B <62723358+wesleyboar@users.noreply.github.com> Date: Tue, 23 Jul 2024 10:04:10 -0500 Subject: [PATCH] docs(README): gh-53 redirect users to new code location (#56) * feat: deprecate repository See #53. * docs(README): GH-53 polish announcement * docs(README): GH-53 better redirect link --- README.md | 94 +++---------------------------------------------------- 1 file changed, 4 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index c05da5c9..8539c770 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,7 @@ # DesignSafe Use Case Template -## A guide to adding your use case project +> [!WARNING] +> **Deprecated.** Content migrated to [DesignSafe-CI/**DS-User-Guide**:`/user-guide/docs/usecases`](https://github.com/DesignSafe-CI/DS-User-Guide/tree/main/user-guide/docs/usecases#readme). To contribute, follow [its README](https://github.com/DesignSafe-CI/DS-User-Guide/tree/main/user-guide/docs/usecases#readme). -1. The PI should Fork the DS Use Case template from the GitHub [repo](https://github.com/DesignSafe-CI/DS_Use_Case_template/) to their own account. If prompted, select an organziation to create the fork. - - ![fork](images/00-fork.png) - - ![forking](images/01-forking.png) - - - The PI can later add their students as collaborators in the settings page: - - ![collaborator](images/collaborator.png) - -1. GitHub will create a forked repo in your user account. Note, the new repo will say it was forked from the original [https://github.com/DesignSafe-CI/DS_Use_Case_template/](https://github.com/DesignSafe-CI/DS_Use_Case_template/). - ![forked-repo](images/02-forked-repo.png) - -1. Navigate to your use case folder, which is located in the `docs` folder. The folders are named after the PI, so find the folder with your name to edit your template. **Always check you are only editing your use case folder**. - ![PI use case folder](images/03-pi-usecase-folder.png) - -1. Click on the `usecase.md` file in your usecase folder to edit your usecase. - ![Edit usecase md](images/04-edit-usecasemd.png) - - ![Edited usecase](images/05-edit-usecase.png) - -1. Once you have completed editing your use case, you save your changes by commiting. Scroll down to the bottom of the page and type a descriptive phrase explaining the changes you have made and click "Commit changes". These changes will be saved only on your repo and will not be reflected in the original DS Use Case repository until you create a pull request. - - ![commit edits](images/06-commit-usecase-edits.png) - -1. To add images to your use case, navigate to your use case folder and select `img` folder. **Ensure that you are in your usecase `img` folder** before adding images. - - ![img folder](images/07-img-folder.png) - ![add image](images/08-add-img.png) - -1. Select image files (you can select multiple files) and click add. Once the images are added as shown below, type a descriptive commit message and click `Commit Changes` to add relevant images to your folder. - - ![upload image](images/09-upload-image.png) - -1. To insert the image in your `usecase.md` file, use the following command: - ``` - ![alternate text](image-location.png) - ``` - In this case, we added an image called `mpm-algorithm.png`, which is located in the use case folder `img`. We can reference it in the text using: - ``` - ![mpm algorithm](img/mpm-algorithm.png) - ``` - > Note: Use relative path `img/mpm-algorithm.png`, **do not use full paths** (e.g., "https://github.com/kks32/DS_Use_Case_Template/docs/kumar/img/mpm-algorithm.png"). - - You can use the preview tab to check images and text formatting before commiting your changes. - - ![preview image](images/11-preview-img.png) - - Commit your changes to GitHub with a meaningful message. - - ![image commit](images/12-image-commit.png) - -1. Before you are ready to make changes to the original DS Use Case repo. Make sure your repository on GitHub is up to date with all the changes from the original repo. You can do this by navigating your repo and click on `Fetch upstream`. It should say nothing new to fetch. - ![fetch upstream](images/16-fetch-upstream.png) - - If there are any new changes you can fetch and merge. - ![fetch merge](images/17-fetch-merge.png) - -1. Once you have completed making changes, you'll now create a Pull Request (PR) to request that your changes be merged to the main DesignSafe Use Case repo. Go to your repo on GitHub (in my case it is [https://github.com/kks32/DS_Use_Case_Template](https://github.com/kks32/DS_Use_Case_Template)). And select `Contribute`, check if it says `This branch is XX comits **ahead** of DesignSafe-CI master`, before opening a pull request: - - ![Open PR](images/18-open-pr.png) - - Complete the title and description of your PR and select `Create Pull Request`: - - ![Create PR](images/19-create-pr.png) - - The PR will show all the changes you have made in the `Files Changed` tab: - - ![PR changes](images/20-pr-file-changes.png) - -1. After a minute or so a preview deployment of your use case will be available on the pull request page. Select the preview link generated by Netlify to view your changes similar to how it would be rendered in the final version. If you want to make some tweaks. Visit *your* GitHub repo of the DS Use Case and make changes. As long as the current PR remains open GitHub will automatically pull your changes. - - ![PR](images/21-pr.png) - - ![preview Web](images/22-preview.png) - -# Docker Image - -A docker image of this environment is built and pushed to [designsafeci/ds-use-case-template:latest](https://hub.docker.com/repository/docker/designsafeci/ds-use-case-template) on commits to `master`. - -## Python Poetry -The image uses [python-poetry](https://python-poetry.org/) to install pinned python dependencies for fully reproducible builds. - -### Adding new packages -1. [Install python-poetry](https://python-poetry.org/docs/master/#installing-with-the-official-installer) -2. Run `poetry add {package} --lock` to add the dependency to the `pyproject.toml` file and the `poetry.lock` lockfile - -*N.B.* This project uses a separate `requirements.txt` file for automated build previews. +> [!IMPORTANT] +> If your content is not available or accurate there, please open a PR to migrate or update it.