docs: Repository for OSS Docs

kubeslice

Last update: Jan 3, 2023

Related tags

Learning resource docs

Overview

Kubeslice Documentation

This project repository contains the documentation for Kubeslice. We are so glad that you want to contribute!

Prerequisites

To use this website, you need

Installation

1. Fork the repository

Go to the project repository on Github and click on Fork button. On this forked copy you can try new ideas.

2. Clone the project

Get the link of your forked repository and clone the repository using git clone.

$ git clone https://github.com/<Github-Username>/<Forked-repo-name>.git

3. Change the directory

Navigate to the directory that contains the project.

$ cd <Forked-repo-name>

4. Install the node modules

$ npm install

This command installs all the dependencies of the project in the local node_modules folder.

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Comments

Require to make changes in the Wording of `Prerequisites` section in `README.md` file

Problem: I have nodejs version 16.13.1 installed but still not able to run the application because nodejs version is not meet to the expected Node js version.

Changes Required: I know this is kind of silly mistake. but it will require to fix. In Prerequisites section it is mentioned that to run the application we require to have the Node js version 14 or greater but it is not true. Require to modify the wording. Please refer this SS.

Excuse me if this issue is not valid.but I thought we require to fix any minor mistake.

opened by amolmote 7
[Blog] What is a Slice

Signed-off-by: Kunal Verma [email protected]

This is the 1st draft of the blog - What is a Slice? (Overlay Network & How it works in KubeSlice) which is to be published next week.

P.S - I have written a technical blog after a long time so, would definitely need suggestions/feedbacks from the community for more improvement. Thanks

opened by verma-kunal 6
Added contribution guide for docs + fixed few rendering errors

The contribution guide for docs has been added along with the sidebar entry. I have also shifted the images to /img under static since the other images folder was throwing an issue while locally rendering the document.

This is how the preview looks.

opened by divya-mohan0209 4
Add check for typo correction across docs (proposal 1)

This is one of the proposed way we can do, I'll make the other PR asap, once we compare we'll understand which would be best choice for the project. PR for #14

opened by sayantani11 1
Docs redirect is intermittently working

The documentation website is https://kubeslice.io and this redirects to https://docs.avesha.io/documentation/open-source/0.2.0. This works intermittently and when hitting the link from the README, this doesn't open for new users.

opened by divya-mohan0209 1
Remove Avesha Docs logo

The Docusaurus website for KubeSlice has the Avesha logo. This will only involve a change in the docusaurus.config.js and is, potentially, a good first issue. We should, ideally, not be having a company logo + a project logo, IMO.

opened by divya-mohan0209 1
AM-6257 - update known issue to the release notes

updated the following known issue to the release notes After a slice is created, the gateway connectivity takes approximately 120 seconds to establish a tunnel.

opened by uma-kt 0
Spellcheck errors should be taken care of

Relates #14 Currently the spellcheck error keeps throwing error for every PR it runs for since it's getting the errors across the repo. So we should try to correct those spellings and add necessary technical words to wordlist.txt.

opened by sayantani11 1
[Blog] What is a Slice

Signed-off-by: Kunal Verma [email protected]

A fresh PR for the blog - What is a Slice

Reason for making a new PR - Was having merge conflicts and issues while signing the commits with the previous PR

Previous pull request associated on this topic: #65

opened by verma-kunal 4
Refactor the KiND cluster setup documentation

The KiND cluster setup documentation has bad UX due to it being one continuous long page. Akin to what's there in the Cloud Cluster setup section, this part needs to be broken up & sectioned appropriately.

Content doesn't need to be added per se since most of the existing content is perfectly fine. Only gaps need to be filled.
documentation good first issue

opened by divya-mohan0209 2

Owner

kubeslice

GitHub

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

JavaScript-med-Ramverk-Laboration-3 Grupprojektet för kurserna Javascript med Ramverk och Agil Utveckling. Utvecklingsguide För information om hur utv

3 May 18, 2022

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Getting Started with Create React App This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: np

4 May 3, 2022

Kurs-repo för kursen Webbserver och Databaser

Webbserver och databaser This repository is meant for CME students to access exercises and codealongs that happen throughout the course. I hope you wi

14 Jan 3, 2023

Exemplo de como deve ser implementação de nirvana do teste de contrato com Pact seguindo todas as práticas descritas em https://docs.pact.io/pact_nirvana

Exemplo de 'Nirvana' do teste de contrato Esse repositório exemplifica as melhores implementações de teste de contrato, atingindo o nirvana e tendo co

66 Nov 28, 2022

Chappe - 🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

Chappe Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine. Chappe is a Developer Do

146 Jan 1, 2023

PHEX, but it shows up as Google Docs in the extensions. Useful if you're using it in class.

3 Oct 28, 2022

🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine. Chappe is a Developer Docs buil

146 Jan 1, 2023

MDN-Dark-Mode - Simple extension to add a dark mode with different themes to the MDN Web Docs website

MDN-Dark-Mode Information Chrome and Firefox extension that adds a dark mode wit

2 Mar 18, 2022

JavaScript Express.js app serving static vanilla JS. This sample app is used in Microsoft Docs to demonstrate how to integrate Azure Storage, Azure Cosmos DB, and Azure Active Directory.

JavaScript on Azure Learn Path - Module 2 - Deploying a basic app to Azure This Learn module requires the following Azure resources to deploy correctl

13 Dec 31, 2022

docs: Repository for OSS Docs

Related tags

Overview

Kubeslice Documentation

Prerequisites

Installation

1. Fork the repository

2. Clone the project

3. Change the directory

4. Install the node modules

Local Development

Build

Comments

Owner

kubeslice

Grupprojekt för kurserna 'Javascript med Ramverk' och 'Agil Utveckling'

Hemsida för personer i Sverige som kan och vill erbjuda boende till människor på flykt

Kurs-repo för kursen Webbserver och Databaser

Exemplo de como deve ser implementação de nirvana do teste de contrato com Pact seguindo todas as práticas descritas em https://docs.pact.io/pact_nirvana

Chappe - 🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

PHEX, but it shows up as Google Docs in the extensions. Useful if you're using it in class.

🧑‍💻 Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

MDN-Dark-Mode - Simple extension to add a dark mode with different themes to the MDN Web Docs website

JavaScript Express.js app serving static vanilla JS. This sample app is used in Microsoft Docs to demonstrate how to integrate Azure Storage, Azure Cosmos DB, and Azure Active Directory.

A Q&A widget for your docs

Example implementation of having Google-Docs like comments

Simple google docs thing in Remix using socket.io.

📒 midubot docs - Discord bot for midudev.

The missing CLI for beautiful, interactive API docs powered by with Stoplight Elements

A community-led experiment to build better docs and helpful content :)

Dockerfiles used in PingCAP's docs CI pipeline

Add Read the Docs preview's link to Pull Requests

GitHub Action that checks code and docs for offensive / exclusive terms and provides warnings.

The docs for PizzaPlace. What else?