From 3827c396972112a61bf26f3c354da9b3bc506eb0 Mon Sep 17 00:00:00 2001 From: Nathalie Casati Date: Wed, 25 Oct 2023 12:06:37 +0200 Subject: [PATCH 1/2] Added CONTRIBUTOR.md --- CONTRIBUTOR.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 CONTRIBUTOR.md diff --git a/CONTRIBUTOR.md b/CONTRIBUTOR.md new file mode 100644 index 0000000..b1ef541 --- /dev/null +++ b/CONTRIBUTOR.md @@ -0,0 +1,47 @@ +# Contributor's Guide + +Thank you for considering contributing to this project. This document outlines the process and guidelines for contributing. + +## Table of Contents +- [Getting Started](#getting-started) +- [Pull Requests](#pull-requests) +- [Code Style](#code-style) +- [Reporting Issues](#reporting-issues) +- [Community and Support](#community-and-support) + +## Getting Started + +1. Fork the repository on GitHub. +2. Clone the forked repository to your local machine. +3. Navigate to the project directory and install the required dependencies. +4. Create a new branch for your feature, bugfix, or improvement. + +## Pull Requests + +1. Make sure all tests pass and there are no linting errors in your code. +2. Commit your changes in a meaningful manner. +3. Push your branch to your fork. +4. Open a pull request from your branch to the project's `master` or `main` branch. +5. Describe the changes you've made in detail and reference any issues it addresses. + +**Note:** Before submitting a pull request, ensure that your changes merge cleanly with the `master` or `main` branch. + +## Code Style + +- Follow the style of the existing code. +- Include comments to explain the purpose and reasoning behind significant pieces of code. +- Write descriptive commit messages. + +## Reporting Issues + +- Use the issue tracker to report bugs or suggest features. +- Before submitting a new issue, please search to see if someone has already reported the same issue. +- Include as much information as possible in your report: steps to reproduce the bug, error messages, your operating system/version, etc. + +## Community and Support + +If you have any questions, join our [discussions](https://github.com/orgs/HIP-infrastructure/discussions). + +--- + +Thank you again for considering contributing to our project! From cd28d888dc86a737bd535d91682728aefcb61274 Mon Sep 17 00:00:00 2001 From: Jonathan Haab Date: Fri, 4 Apr 2025 10:11:30 +0200 Subject: [PATCH 2/2] fix urls --- src/components/Documentation/About.tsx | 4 ++-- src/components/Documentation/GettingStarted.tsx | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/components/Documentation/About.tsx b/src/components/Documentation/About.tsx index 1d4b222..3e878fa 100644 --- a/src/components/Documentation/About.tsx +++ b/src/components/Documentation/About.tsx @@ -17,7 +17,7 @@ const spaces: Doc[] = [ { label: 'Onboarding Guide', buttonLabel: 'guide', - url: 'https://hip-infrastructure.github.io/build/html/hip_onboarding.html', + url: 'https://hip-infrastructure.github.io/user_doc.html', description: 'See the onboarding guide for a quick overview of the platform.', image: 'public/media/discover_onboarding.png', @@ -59,7 +59,7 @@ const docs = [ { label: 'HIP User Documentation', buttonLabel: 'User Documentation', - url: `https://hip-infrastructure.github.io/`, + url: `https://hip-infrastructure.github.io/user_doc.html`, description: 'HIP guides, tutorials, datasets, Troubleshooting and FAQ', image: 'public/media/documentation_user.png', credit: diff --git a/src/components/Documentation/GettingStarted.tsx b/src/components/Documentation/GettingStarted.tsx index 05daab1..725614c 100644 --- a/src/components/Documentation/GettingStarted.tsx +++ b/src/components/Documentation/GettingStarted.tsx @@ -136,7 +136,7 @@ const GettingStarted = (): JSX.Element => { } video='getting-started-upload.mp4' link={ - 'https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_prepare_and_upload_data_to_the_HIP.html' + 'https://hip-infrastructure.github.io/guides/GUIDE_How_to_prepare_and_upload_data_to_the_HIP.html' } /> { subtitle='Use a Desktop App to process your data.' description={'Use Desktops and run applications'} img='gettingstarted-2.png' - link='https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_use_Desktops_and_run_applications_from_the_App_Catalog.html' + link='https://hip-infrastructure.github.io/guides/GUIDE_How_to_use_Desktops_and_run_applications_from_the_App_Catalog.html' /> { } img='gettingstarted-3.png' - link='https://hip-infrastructure.github.io/build/html/guides/GUIDE_How_to_use_the_HIP_spaces_and_share_data_with_other_users.html' + link='https://hip-infrastructure.github.io/guides/GUIDE_How_to_use_the_HIP_spaces_and_share_data_with_other_users.html' />