From fcc2ebd9ac5a6141b2935f253bd563e58dc24b2c Mon Sep 17 00:00:00 2001 From: lawtlee Date: Thu, 7 Sep 2023 15:19:40 -0700 Subject: [PATCH] Removed DSQ Documentation The documentation was moved to https://github.com/ucla-data-science-center/docs --- docs/datasquad-website-guide/add-link-btn.md | 47 -------------- docs/datasquad-website-guide/add-projects.md | 39 ------------ docs/datasquad-website-guide/blogs.md | 43 ------------- .../datasquad-website-guide.md | 11 ---- docs/datasquad-website-guide/debugging.md | 61 ------------------- docs/datasquad-website-guide/index.md | 8 --- docs/onboarding/index.md | 2 +- 7 files changed, 1 insertion(+), 210 deletions(-) delete mode 100644 docs/datasquad-website-guide/add-link-btn.md delete mode 100644 docs/datasquad-website-guide/add-projects.md delete mode 100644 docs/datasquad-website-guide/blogs.md delete mode 100644 docs/datasquad-website-guide/datasquad-website-guide.md delete mode 100644 docs/datasquad-website-guide/debugging.md delete mode 100644 docs/datasquad-website-guide/index.md diff --git a/docs/datasquad-website-guide/add-link-btn.md b/docs/datasquad-website-guide/add-link-btn.md deleted file mode 100644 index 8dc5818..0000000 --- a/docs/datasquad-website-guide/add-link-btn.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Add Button with Link -layout: default -parent: DataSquad Website Guide -nav_order: 2 - ---- - -# Adding Button with Link -1. **In the [Datasquad repository](https://github.com/UCLA-DataSquad/ucla-datasquad.github.io) (or it can be your local repository), navigate to `_data/sitetext.yml` file.**\ -step1 - -2. **In the section where you want to add the button, add the following lines:** - - I will be referring to your desired section as `[your-desired-section]`. In my case, it will be the `about` section. - ``` - button: [your-button-title] - buttonlink: [your-desired-link] - ``` - - Note that I will be adding the button in the `About` section, so I go to the `about` section in `sitetext.yml`, and add the follwing lines: - ``` - button: Here's a button with a link - buttonlink: https://github.com/UCLA-DataSquad/ucla-datasquad.github.io - ``` - - what it should look like in the file: \ - step2 - -3. **Navigate to `_includes/[your-desired-section].html`.** -step3 - -4. **Paste the following lines:** - - ``` - {% raw %} - {%- if site.data.sitetext[site.locale].[your-desired-section].button -%} - {{ site.data.sitetext[site.locale].[your-desired-section].button }} - {%- endif -%} - {% endraw %} - ``` - - Note that in the actual file, you need to change all `[your-desired-section]` to the actual section name where you want the button to be. - - The file should look something like this. Notice that all `[your-desired-section]` has been changed to `about`: - step4 - -5. **Once you push your changes to the main branch, you should see the button in your desired section:**\ - - Make sure to click it and check that it links to a correct website! - step5 - -6. **Congrats! You added a button to the website! 🎉👏👏👏** \ No newline at end of file diff --git a/docs/datasquad-website-guide/add-projects.md b/docs/datasquad-website-guide/add-projects.md deleted file mode 100644 index fd5db39..0000000 --- a/docs/datasquad-website-guide/add-projects.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Add Projects -layout: default -parent: DataSquad Website Guide -nav_order: 1 - ---- - -# Adding New Projects under "Projects" section -1. **In the [Datasquad repository](https://github.com/UCLA-DataSquad/ucla-datasquad.github.io) (or it can be your local repository), navigate to `_portfolio` folder.** -step1 - -2. **Create a new `.md` file in the folder and name it appropriately.** -step2 - -3. **Copy the front matter from any of the other project files in `_portfolio` folder.** -step3 - -4. **Paste the front matter into the project file you created.** -step4 - -5. **Edit the front matter so it reflects the content of your project.** - - `title`: the title of your project. - - `thumbnail`: the path to the thumbnail image of your choice. You can add a new image under `assets/img/portfolio`. - - `subtitle`: subtitle that goes under the main title. This is optional. - - `alt`: alternate caption for your image. - - `image`: path to the image you want to be displayed once the project card is clicked. Usually matches `thumbnail`, but it can also be any other image of your choice. -step5\ -step5 - -6. **Add content to your project.** -step6 - -7. **Once you push your changes to the main branch, you should see something like this:** -step7\ -This is what it looks like when you click on the project card: -step7 - -8. **Congrats! You just published your project to the DataSquad Website! 🎉👏👏👏** \ No newline at end of file diff --git a/docs/datasquad-website-guide/blogs.md b/docs/datasquad-website-guide/blogs.md deleted file mode 100644 index 3704f3b..0000000 --- a/docs/datasquad-website-guide/blogs.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Add/Manage Blogs -layout: default -parent: DataSquad Website Guide ---- - -# Adding Blogs - -1. Navigate to the `_posts` directory - -2. On the top right corner: Add file -> create new file - - ![create new blog]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/add-blog-2.png) - - **Note** The naming convention of these .md files is important, and must follow the format: '`YEAR-MONTH-DAY-title.MARKUP`'. The permalinks can be customized for each post, but the date and markup language are determined solely by the file name. - -3. Update the title, layout and author of the file - - ![update blog information]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/add-blog-3.png) - -4. Your new blog should now show up on the website after you push and deploy your changes! - - ![blog post displayed on site]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/add-blog-4.png) - -# Highlighting Blogs - -To highlight a blog, add this section to the top of the post. - -![Blog Highlight Front-matter]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/highlight-1.png) - -1. You need to have ``` showcase: 1 ```, this will signifiy that you wan the blog highlighted. - -2. You need to add the ``` card ``` section. This section is exactly like a project card except for the last two variables. Refer to [Add Projects]({{ site.baseurl }}/docs/datasquad-website-guide/add-blogs/add-projects) - -3. ``` intro: ``` This is what is going to be displayed on the blog card. Write a short introduction to the blog here. - -4. ``` url: ``` The url should be the date followed by the file name in the following format: ```YYYY/MM/DD/File_name``` - -After adding this to a blog post, it should appear like the following on the webpage: - -![Blog Card]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/highlight-2.png) - -![Blog Card]({{ site.baseurl }}/assets/img/datasquad-website-guide/add-blogs/highlight-3.png) \ No newline at end of file diff --git a/docs/datasquad-website-guide/datasquad-website-guide.md b/docs/datasquad-website-guide/datasquad-website-guide.md deleted file mode 100644 index 1ab37d1..0000000 --- a/docs/datasquad-website-guide/datasquad-website-guide.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: DataSquad Website Guide -layout: default -permalink: /docs/datasquad-website-guide -has_children: true -nav_order: 4 ---- - -Refer to [Add Projects]({{ site.baseurl }}/docs/datasquad-website-guide/add-projects) and -[Add/Manage Blogs]({{ site.baseurl }}/docs/datasquad-website-guide/blogs) to add projects/blogs. -If you have any issues with Projects/Blogs loading on the site refer to [Debugging]({{ site.baseurl }}/docs/datasquad-website-guide/debugging) \ No newline at end of file diff --git a/docs/datasquad-website-guide/debugging.md b/docs/datasquad-website-guide/debugging.md deleted file mode 100644 index c2aa75a..0000000 --- a/docs/datasquad-website-guide/debugging.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Debugging -layout: default -parent: DataSquad Website Guide ---- - -If you have any issues with either your blog highlight or project card showing up read this documentation. - -## Check Github Actions -First, check for any **Github Action** errors. If there are any errors it may mean that the workflow designed to update -the site failed. To navigate to the potential source of error follow the steps below: - -1. Navigate to **Github Actions** in the [DataSquad Site Repo](https://github.com/UCLA-DataSquad/ucla-datasquad.github.io) - - ![Github Actions]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/actions-1.png) - -2. Look at the most recent workflows, if there is no workflow with an X then that means everything completed perfectly and you can move on. -If not it looks like: - - ![Workflow]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/actions-2.png) - -3. Click on the failed workflow and look through it and see what failed. If the workflow failed because of jekyll being unable to run -that means that there is code in your most recent commit that breaks jekyll. Look through the changes you've made and try to identifiy any code -that may have done so. If you click deeper into the workflow it may tell you what the error is. - - ![Workflow Error]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/actions-3.png) - ![Workflow Error Details]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/actions-4.png) - -## Check the Repository - -Now if your workflow error has a specific about what went wrong with jekyll follow the error message and locate your bug. If your workflow error has -nothing to do with jekyll or it has no error at all follow the steps below. If you don't care how it works skip to **step 5** - -1. **Count the number of files in the _posts folder.** - - The following example has 5 posts. - - ![Post Count]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/repo-1.png) - -2. **Check the _includes/modals.html file.** - - Look for the following line of code \ - {% raw %} `{% assign modified_index = forloop.index | plus: %}`. {% endraw %} - You can `ctrl/cmd + f` the following to find it: `assign modified_index` - - ![modals.html]({{ site.baseurl }}/assets/img/datasquad-website-guide/debugging/repo-2.png) - - Notice how the number after `plus` doesn't align with the number of blog posts. The error exists here and you should change it to the appropriate - number of blogs. - -3. **Check the _includes/portfolio_grid.html file.** - - Look for the same line of code as _includes/modals.html If there are any discrepancies with the code make that fix. - -4. Run Jekyll locally with the `bundle exec jekyll serve` command and see if your blog/project appears. - -5. To avoid doing all of that work you can just run the *blog_script,sh* with the following command: - `./blog_script.sh` - -If this does not solve your issue, then you will have to debug for the issue on your own. A good start is to look at the files -you have added/modified and work backwards from there until you reach the source of error. \ No newline at end of file diff --git a/docs/datasquad-website-guide/index.md b/docs/datasquad-website-guide/index.md deleted file mode 100644 index 0ca29fb..0000000 --- a/docs/datasquad-website-guide/index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: default -has_children: true ---- - -Refer to [Add Projects]({{ site.baseurl }}/docs/datasquad-website-guide/add-projects) and -[Add/Manage Blogs]({{ site.baseurl }}/docs/datasquad-website-guide/blogs) to add projects/blogs. -If you have any issues with Projects/Blogs loading on the site refer to [Debugging]({{ site.baseurl }}/docs/datasquad-website-guide/debugging) \ No newline at end of file diff --git a/docs/onboarding/index.md b/docs/onboarding/index.md index c36baf8..1540219 100644 --- a/docs/onboarding/index.md +++ b/docs/onboarding/index.md @@ -6,7 +6,7 @@ has_children: true nav_order: 2 --- -#Onboarding +# Onboarding This documentation is written for students that onboarding to the UCLA IMLS