Skip to content

Latest commit

 

History

History
333 lines (226 loc) · 12 KB

Readme.md

File metadata and controls

333 lines (226 loc) · 12 KB
Raw

Akash Network Website Guide

Akash Network Website

Explore the repository for the Akash Network website, skillfully developed by Hooman Digital. The website serves as a dynamic showcase, illustrating the prowess and capabilities of Akash Network—a decentralized cloud computing marketplace revolutionizing the digital landscape.

Getting Started Locally

To run the repository locally and explore the website on your machine, follow these simple steps:

  1. Clone the Repository:

    git clone https://github.com/akash-network/website-revamp

  2. Navigate to the Project Directory:

    cd website-revamp

  3. Install Dependencies:

    npm install

  4. Run the Development Server:

    npm run dev

  5. Open Your Browser: Visit http://localhost:4321 to view the Akash Network website locally.

Contribution Guidelines

Before contributing to the project, please adhere to the following guidelines to ensure the project's integrity and maintainability.

File Naming Convention

When creating files for components, pages, etc., follow this straightforward file naming convention:

  • Component Name: Utilize kebab-case, featuring lowercase words separated by hyphens.

    Example: my-component-name.js

Commit Message Structure

Each commit message should carry a meaningful structure, commencing with a type and followed by a concise description. Utilize the following types for commit messages:

  • feat: Introduce a new feature or functionality to the codebase.

    Example: feat: implement user authentication

  • fix: Rectify a bug or address an issue within the code.

    Example: fix: resolve issue with login page

  • docs: Focus on documentation-related changes, such as updating comments, README files, or documentation pages.

    Example: docs: enhance installation instructions

  • style: Implement code style changes, such as formatting, indentation, or variable renaming.

    Example: style: refactor CSS styles

  • chore: Undertake routine tasks, maintenance, or housekeeping activities, often not directly related to code changes.

    Example: chore: update dependencies

  • test: Contribute to or modify tests, including unit tests, integration tests, or end-to-end tests.

    Example: test: add test cases for login feature

  • perf: Optimize the code for better performance.

    Example: perf: enhance database query efficiency

  • ci: Implement changes to the continuous integration (CI) pipeline.

  • refactor: Enhance code structure without introducing new features or fixing bugs.

    Example: refactor: extract reusable function

  • build: Make changes related to the build process, such as build scripts or tools.

    Example: build: update webpack configuration

  • revert: Revert a previous commit.

    Example: revert: undo changes from commit abc123

  • deps: Update or modify project dependencies, such as npm packages or libraries.

    Example: deps: upgrade lodash to version 4.0.0

Commit Message Best Practices

  • Keep commit messages concise and to the point.
  • Utilize the imperative mood (e.g., "add," "fix," "update") in the description.
  • Provide context in the description when necessary.

How to Contribute to the Akash Website

How to write a blog

  1. Create a new folder under src/content/Blog/ with the name of the blog. For example, src/content/Blog/how-to-use-akash-web/
  2. Create a new file called index.md under the new folder. For example, src/content/Blog/how-to-use-akash-web/index.md
  3. Copy the following template into the new file and fill in the details.
---
title: "Example Blog Title"
description: "Example Blog Description"
pubDate: "2019-11-25"
draft: false
archive: true
categories:
  - Category1
  - Category2
tags:
  - Tag1
  - Tag2
contributors:
  - Greg Osuri
bannerImage: ./banner-image.jpg
---
  1. Add the banner image to the same folder as the markdown file. For example, src/content/Blog/how-to-use-akash-web/banner-image.jpg
  2. Write the blog content in markdown format in the same file. For example, src/content/Blog/how-to-use-akash-web/index.md
  3. Commit and push the changes to the repository. The blog will be published automatically.

Community

How to add to the Events

  1. Create a new folder under src/content/Community_Akash_Events_Page/ with the name of the event. For example, src/content/Community_Akash_Events_Page/ai-world-congress/
  2. Create a new file called index.md under the new folder. For example, src/content/Community_Akash_Events_Page/ai-world-congress/index.md
  3. Copy the following template into the new file and fill in the details.
---
title: AI World Congress
image: "./project-banner.png"
eventDate: "2024"
tbd: true
location: Singapore
link: "https://www.asia.token2049.com/"
description: ​TOKEN2049 brings together the global Web3 industry, uniting entrepreneurs, investors, developers, industry insiders and global media - and creates unparalleled networking opportunities.
---

  1. TBD means the date is not confirmed yet. If the date is confirmed, remove the tbd: true line.

  2. Add the banner image to the same folder as the markdown file. For example, src/content/Community_Akash_Events_Page/ai-world-congress/project-banner.png

  3. Commit and push the changes to the repository. The event will be published automatically.

How to contribute to the Akash Edu

  1. Create a new folder under src/content/Community_Akash_Edu_Page/ with the name of the contribution. . For example, src/content/Community_Akash_Edu_Page/cloudmos-101/

  2. Create a new file called index.md under the new folder. For example, src/content/Community_Akash_Edu_Page/cloudmos-101/index.md

  3. Copy the following template into the new file and fill in the details.

---
title: Akash EDU - Cloudmos 101
image: "./project-banner.png"
pubDate: "2020-01-19"
tags:
  - Upcoming
description: In this course, you will learn how to deploy your project onto the Akash Network using Cloudmos — a simple, point and click deployment tool.
link: "https://akash-edu.ctlabs.in/"
---

  1. Add the banner image to the same folder as the markdown file. For example, src/content/Community_Akash_Edu_Page/cloudmos-101/project-banner.png

  2. Commit and push the changes to the repository. The event will be published automatically.

How to contribute to the Community Contributions

  1. Create a new folder under src/content/Community_Contributions_Page/ with name of the contribution . For example, src/content/Community_Contributions_Page/akash-101/

  2. Create a new file called index.md under the new folder. For example, src/content/Community_Contributions_Page/akash-101/index.md

  3. Copy the following template into the new file and fill in the details.

---
title: "Akash Network Live with Greg Osuri: Akash’s progress in 2023, open community development, and more"
image: "./project-banner.png"
pubDate: "2023-02-24"
readTime: "5 min"
author: "Robert Del Rey"
link: https://www.youtube.com/watch?v=aVRqwXOxoe8
tags:
  - Video
description: Greg Osuri, CEO of Overclock Labs and Founder of Akash Network, will cover the progress Akash has already made in 2023, our new open community group structure, and what to look out for in the coming months.
---

  1. Add the banner image to the same folder as the markdown file. For example, src/content/Community_Contributions_Page/akash-101/project-banner.png

  2. Commit and push the changes to the repository. The event will be published automatically.

Ecosystem

How to contribute a project to the Ecosystem

  1. Create a new folder under src/content/Ecosystem_Page/ with the name of the project. For example, src/content/Ecosystem_Page/akash-chat/

  2. Create a new file called index.md under the new folder. For example, src/content/Ecosystem_Page/akash-chat/index.md

  3. Copy the following template into the new file and fill in the details.

  4. There are four categories deployed_on_akash, akash-tools

---
projectTitle: Akash Chat
projectImage: "./project-banner.png"
pubDate: "2021-01-19"

tags:
  - AI & ML

category: deployed_on_akash

description: Mistral-7B-v0.2 Large Language Model (LLM) is a pretrained generative text model with 7 billion parameters by Mistral AI. This application is running on NVIDIA GPUs leased from the Akash Supercloud.

showcase: true

websiteLink: "https://chat.akash.network/"
githubLink: "https://chat.akash.network/"
twitterLink: "https://chat.akash.network"

featured: true
---

  1. Showcase is used to show the card in showcase in ecosystem tag

  2. Featured is used to show the card on the top of the page

  3. Add the banner image to the same folder as the markdown file. For example, src/content/Ecosystem_Page/akash-chat/project-banner.png

  4. Commit and push the changes to the repository. The event will be published automatically.

Docs

How to change sequence of docs

  1. Go to the src/content/Docs/sequence.ts
  2. Change the sequence of the docs
export const docsSequence = [
  {
    label: "Docs",
    subItems: [
      {
        label: "Getting Started", // <--- Change the sequence here
        subItems: [ // <--- Change the sequence here
          { label: "Intro To Akash" }, // <--- Change the sequence here
          { label: "Akash Overview" }
          { label: "Stack Definition Language (SDL)" },
          { label: "Tokens and Wallets" },
        ],
      },
  }
]

  1. Name of the label should same as rendered name of the doc in the website

  2. Commit and push the changes to the repository. The event will be published automatically.

How to add new file in docs

  1. Create a new folder under src/content/docs with the name of the file. For example, src/content/docs/akash-101/

  2. Create a new file called index.md under the new folder. For example, src/content/docs/akash-101/index.md

  3. Copy the following template into the new file and fill in the details.

---
categories: ["Akash Nodes"] # <--- Change the category here
tags: ["Blockchain"] # <--- Change the tag here
weight: 1 # <--- Change the weight here
title: "Akash Node CLI Build" # <--- Change the title here
linkTitle: "Akash Node CLI Build" # <--- Change the link title here
---

  1. If you want to add sub items, add the folder under the folder of the doc. For example, src/content/docs/akash-101/akash-node-cli-build/

  2. Create a new file called index.md under the new folder. For example, src/content/docs/akash-101/akash-node-cli-build/index.md

Contact

Discord - Akash Network

Twitter: Akash Network

Website: Akash Network