319 strapi docs (#364)

* Strapi docs * Strapi backend docs * docs(backend): 📝 Update docs --------- Co-authored-by: Lucas Tran <lucastran1107@gmail.com> Co-authored-by: Mads Hermansen <mads.d.hermansen+main@gmail.com>
NTNU-SmallSatLab · Apr 24, 2024 · 64282e0 · 64282e0
1 parent 5bf10e6
commit 64282e0
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 0 deletions.
diff --git a/docs/Images/StrapiBody.png b/docs/Images/StrapiBody.png
diff --git a/docs/Images/StrapiTypes.png b/docs/Images/StrapiTypes.png
diff --git a/docs/Images/StrapiYTVideo1.png b/docs/Images/StrapiYTVideo1.png
diff --git a/docs/Images/StrapiYTVideo2.png b/docs/Images/StrapiYTVideo2.png
diff --git a/docs/Images/StrapiYTVideo3.png b/docs/Images/StrapiYTVideo3.png
diff --git a/docs/Images/StrapiYTVideo4.png b/docs/Images/StrapiYTVideo4.png
diff --git a/docs/STRAPI.md b/docs/STRAPI.md
@@ -0,0 +1,70 @@
+## Strapi
+
+It is advisable to have some knowledge about strapi before using this application. Please refer to this introduction:
+
+https://docs.strapi.io/dev-docs/intro
+
+When first loading up strapi, you will see see 7 different types.
+
+![alt text](Images/StrapiTypes.png)
+
+## Article
+
+In the article collection type, there are 6 fields you can fill. slug, datePublished, coverImage, body, author, tag and previewTitle.
+
+The slug is an identifier that can be autogenerated or manually generated.
+
+DatePublished is the date when the article was published or written.
+
+CoverImage is the image that is displayed on the preview.
+
+Body is the content that is displayed when clicking on a specific blog. In Blog you can add images, and text.
+
+![alt text](Images/StrapiBody.png)
+
+In the body, you are also able to add youtube videos. To be able to do that, you need to do the following[^1]:
+
+1. Find a youtube video
+2. Click on share button ![Share button](Images/StrapiYTVideo1.png)
+3. Click on embed button ![Embed button](Images/StrapiYTVideo2.png)
+4. Copy the source ![Copy src](Images/StrapiYTVideo3.png)
+5. Click on the link button in the body field ![Click link button](Images/StrapiYTVideo4.png)
+6. Final step is to add the link you copied from step 4.
+
+Author is a relation to another author collection type.
+
+Tag is a tag that can be used for filtering the blogs by tags.
+
+Preview title is the title only dislayed on the blog-card.
+
+## Author
+
+In author you can add the following fields:
+
+1. Name
+2. Avatar
+3. Articles
+
+Name is the name of the author
+
+Avatar is the profile image of the author. If avatar is not provided, the initials will be used for the author avatar.
+
+Articles are the articles the author has written
+
+## Project
+
+In project there are 5 fields:
+
+1. Title
+2. Slug
+3. Satellites
+4. Content
+5. Preview Image
+
+Title will only be displayed on the project preview card (same as article)
+
+Slug is an identifier for the project
+
+Satellites are the related satellites
+
+Content is the content of the project. Here you can also add images and youtube embeddings. Refer to this [^1]: tutorial to add youtube embeddings.