Repository files navigation

We appreciate your interest in contributing to the SigNoz blog! Follow the steps below to create and submit your blog post.

1. Go to theSigNoz GitHub repository.
2. Click on the "Fork" button at the top-right corner of the page. This will create a copy of the repository under your GitHub account.

1. On your GitHub account, navigate to the forked repository.

2. Click the "Code" button and copy the URL.

3. Open your terminal and run the following command to clone the repository:

   git clone<https://github.com/your-username/signoz-web.git>

4. Navigate into the cloned directory:

   cd signoz-web

Setting up the upstream repository allows you to fetch changes from the original repository and keep your fork in sync.

1. Add the original repository as the upstream remote:

   git remote add upstream https://github.com/SigNoz/signoz-web.git

2. Verify the new remote namedupstream:

   git remote -v

It's good practice to create a new branch for your changes. This helps in organizing and managing the contributions.

1. Create a new branch:

   git checkout -b add-new-blog

1. Navigate to thedata/blog directory:

   cd data/blog

2. Create a new.mdx file. The file name should correspond to the URL of the blog post. For example, if your blog post URL ishttps://signoz.io/blog/opentelemetry-spring-boot/, the file name should beopentelemetry-spring-boot.mdx.

3. Add the content for your blog post in the.mdx file. Refer to previous blog posts in thedata/blog directory for the format. Ensure your file includes the following:

   • Cover Image: Add a relevant cover image for your blog post.
   • Metadata: Include necessary metadata such as title, date, author, tags, etc.
   • Canonical Links: Set up canonical links to ensure proper SEO.

1. Navigate to thepublic/img/blog directory:

   cd public/img/blog

2. Create a new folder for the current month (if it doesn't already exist). For example, if you are writing the blog in May 2024, create a folder named2024-05.

3. Add your images to the folder you just created.

1. Add your changes:

   git add.

2. Commit your changes:

   git commit -m"Added new blog post: [your blog post title]"

Before pushing your changes, it's a good idea to fetch and merge any changes from the upstream repository to ensure your fork is up-to-date.

1. Fetch the latest changes from the upstream repository:

   git fetch upstream

2. Merge the changes into your current branch:

   git merge upstream/main

1. Push your branch to your forked repository:

   git push origin add-new-blog

1. Install the project dependencies using Yarn:

   yarn install

2. Build the project to ensure there are no errors:

   yarn build

3. This will create abuild directory with the production build of the website. Check the output for any errors.

1. Start the development server:

   yarn start

2. Open your browser and navigate tohttp://localhost:3000 to view the website locally. Check your blog post to ensure everything looks correct.

1. Navigate to your forked repository on GitHub.
2. Click on the "Compare & pull request" button.
3. Add a title and description for your pull request.
4. Click on "Create pull request".

Your pull request will be reviewed, and if everything looks good, it will be merged into the main repository. Thank you for your contribution!

• Refer to Previous Blogs: You can refer to existing blogs in thedata/blog directory to get an idea of the format and structure.
• Cover Image and Metadata: Ensure that you include a relevant cover image and all necessary metadata to make your blog post complete and SEO-friendly.
• Images: Make sure to place your images in the correct month folder underpublic/img/blog.

If you have any questions or need further assistance, feel free to reach out to the SigNoz team.

We can add aNEW tag for doc that went live recently. To do this, you just need to addclassName: 'new-doc' key value pair to the doc in thedocsSideNav.ts file. For example, if a new doc for LLM monitoring went live, you can add a new tag to it as follows:

{route:'/docs/community/llm-monitoring',label:'LLM Monitoring',type:'doc',className:'new-doc',},

You can do the same for a Category. For example, if you're adding a new category with the labelAzure Monitoring and it has multiple docs inside it, you can add a new tag as shown below:

{label:'Azure Monitoring',type:'category',className:'new-doc',items:[{         ...},],