Merge branch 'main' of https://github.com/tcet-opensource/documentation…

… into 241-tl-troubleshoot-welcome-app

.env

@@ -0,0 +1,3 @@
+API_KEY=066a2ed9cfc332fb09112a9059ccdbf7
+APPLICATION_ID=QFLBKAUEYJ
+index=tcetopensource

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+ko_fi: tcetopensource
+custom: [buymeacoffee.com/tcetopensource]

.github/workflows/build.yml

@@ -4,15 +4,12 @@ on:
   pull_request:
     branches:
       - main
+      - staging
+      - blogs
   workflow_dispatch:
 
 permissions:
   contents: read
-
-env: 
-  API_KEY: ${{secrets.API_KEY}}
-  APPLICATION_ID: ${{secrets.APPLICATION_ID}}
-  index: ${{secrets.index}}
 
 jobs:
   build:
@@ -21,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Node
         uses: actions/setup-node@v3
         with:

.gitignore

@@ -14,7 +14,6 @@
 .env.development.local
 .env.test.local
 .env.production.local
-.env
 
 npm-debug.log*
 yarn-debug.log*

README.md

@@ -6,6 +6,13 @@ One of the key visions of the TCET Open Source Organization is to provide users
 
 The **Documentation Website** will act as our Organization's website. It will consist of the *documentation of all projects* undertaken by TCET Open Source. The website will also have dedicated *blogs contributed by the community* covering various different interests.
 
+## Hacktoberfest
+### Powered by:
+<img width="311" alt="mlh-logo-color" src="https://github.com/tcet-opensource/hacktober-fest/assets/55846983/d5ccae96-86a7-4fed-8f00-e9f1d0aa5cac">
+
+### How to contribute
+Read our [workflow](https://opensource.tcetmumbai.in/docs/resources/workflows/external-workflow/) guide, and have a look at issues marked with the <code>Hacktoberfest</code> tag on it. Do not forget to read the rest of the README. For serious doubts, contact the project maintainers on our discord server.
+
 ## Cloning
 
 To clone the repository copy paste the following command in your system's terminal.
@@ -30,6 +37,25 @@ Run the project live on your local system to make changes and check the updates.
 npm run start
 ```
 
+## .env File Setup  
+
+In addition to cloning the repository and setting up the project as described above, you will need to create a .env file to configure certain environment variables. These variables are essential for the proper functioning of the Documentation Website. Here's how you can set up the .env file:
+
++ Create the .env file: First, create a file named .env in the root directory of your cloned repository.
+
++ Add API Key and Application ID: Inside the .env file, you'll need to set two important variables: API_KEY and APPLICATION_ID. These variables are used for connecting to external services or APIs that the website may rely on.
+
+```
+API_KEY=<your_api_key>
+APPLICATION_ID=<your_id>
+index=tcetopensource
+```
+
++ API_KEY should be replaced with the actual API key required for your project. Make sure to obtain the API key from the respective service or provider you're using.
+
++ APPLICATION_ID should be replaced with the unique application ID required for your project. Again, obtain this ID from the relevant service or provider.
+
+
 <div align="center">
 <h3> Connect with us<a href="https://gifyu.com/image/Zy2f"><img src="https://github.com/milaan9/milaan9/blob/main/Handshake.gif" width="50px"></a>
 </h3> 
@@ -39,4 +65,4 @@ npm run start
     <a href="https://discord.gg/r7ZhAREg2M" target="_blank"><img alt="Discord" width="40px" src="https://cdn-icons-png.flaticon.com/512/5968/5968756.png"></a> &nbsp&nbsp&nbsp
     <a href="mailto:[email protected]" target="_blank"><img alt="Gmail" width="40px" src="https://cdn-icons-png.flaticon.com/512/5968/5968534.png"></a> &nbsp&nbsp&nbsp 
     <a href="https://www.linkedin.com/company/tcet-opensource/" target="_blank"><img alt="LinkedIn" width="40px" src="https://cdn-icons-png.flaticon.com/512/3536/3536505.png"></a> &nbsp&nbsp&nbsp
-</p> 
+</p> 

blog/2023-04-01-blog-guidlines/index.md → blog/2023-10-01-blog-guidlines/index.mdx

@@ -1,9 +1,9 @@
 ---
 slug: blog-posting-guidelines
-title: First Blog - General Posting Guidelines
+title: General Posting Guidelines
 authors: [gaurang, vishal]
 tags: [free, open, source, software]
-description: First Blog - General Posting Guidelines
+description: General Posting Guidelines
 keywords: [free, open, source, software]
 ---
 
@@ -13,10 +13,12 @@ Welcome everyone to TCET Open Source's Blog Section. Here, we promote blogging i
 
 :::note
 
-This particular blog will have recurring adjustments.
+This particular blog will have recurring adjustments. Last revised on Oct 1st, 2023.
 
 :::
 
+<!--truncate-->
+
 ## General Blog Guidlines
 
 Here we define all the basic guidlines a blog should follow in TCET Open Source Blogs.
@@ -40,11 +42,11 @@ Once you have cloned the project in your local storage, you will need to perform
 yyyy-mm-dd-blog-title
 ```
 * Here, the date stands for the date when the post is supposed to be released. The blog title should be relevant to the content within the post.
-3. Within the folder, create `index.md`. This file will serve as a text document where you can format your content which will reflect in the final post.
+3. Within the folder, create `index.mdx`. This file will serve as a text document where you can format your content which will reflect in the final post.
 
 ### Understand markdown files and syntax
 
-Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. The `index.md` file created in your blog folder is a markdown file, similar to how _index.html_ can be an HTML file. It is very essential for a blog contributor to understand the basic syntax of markdown. _Resource forum_ in our **Discord server** covers basic syntax of these files.
+Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. The `index.mdx` file created in your blog folder is a markdown file, similar to how _index.html_ can be an HTML file. It is very essential for a blog contributor to understand the basic syntax of markdown. _Resource forum_ in our **[Discord server](https://discord.com/invite/r7ZhAREg2M)** covers basic syntax of these files.
 
 ### First steps
 
@@ -61,12 +63,12 @@ These four information are necessary to be present in every post. Without these,
 :::info Mention Authors
 
 Authors can be added in two ways.
-- Internally in `index.md` (recommended, for outside organization contributors)
+- Internally in `index.mdx` (recommended, for outside organization contributors)
 - In the `authors.yml` file. (**TCET Open Source Members only**)
 
 If you are not a member of the organization, you can simply append your author(s) in the following way:
 
-```md
+```mdx
 authors:
   - name: Name of Author 1
     title: Designation, Post or About
@@ -90,7 +92,7 @@ authors:
 Tired of good ol' _textbook nerdy_ look on your post? Introducing: **images**. Images are a great way to keep the reader's attention to your posts, and now you can do that very easily:
 1. The image must be present within your blog folder. If it isn't, save the image in your blog folder.
 2. To add the image within your post, use the following syntax:
-```sh
+```mdx
 ![Alt text](image.png)
 ```
 * Here, `image.png` stands for the name of the image you have in the blog directory. Markdown supports a great amount of image formats, ranging from png, jpg, svg, and even gifs.
@@ -99,6 +101,28 @@ Tired of good ol' _textbook nerdy_ look on your post? Introducing: **images**. I
 Is gif pronounced _gif_ or _jif_? Something to ponder upon.
 :::
 
+### Utilizing truncate
+
+Many bloggers have many different ways to write their blogs. Many start off with a nice paragraph, some start off with images, and some do both! All blogging practices are welcome in the Organization. However it is important to **truncate**.
+
+Truncate is a custom breakpoint introduced in the blog to identify how much part of the blog should be visible in the feed. It cuts off the rest of the blog which can be read further by opening the blog itself. Here's a good example of how to use it:
+
+:::info This is a blogpost
+```mdx
+Hello and welcome to my blogpost.
+Today we will be covering everything you can imagine! 
+JAM Stack, Web3, ML, Data Science, my favourite food, Cybersecurity, and much more. 
+Sounds like a hefty lot, and it would be embarassing to flood out the entire blogs feed. 
+This might be a decent place to cut the rest of the blog out!
+
+<!--truncate-->
+
+Here's where the rest of the blog content goes
+```
+:::
+
+Hence in the output, only the above paragraph is visible on the feed. The rest of the blog would be visible once the viewer opens your blog.
+
 ### Congratulations
 
 Following these steps and points, you will be able to create a beautiful blog post. It's final structure would look something like this: