jupyter-naas/site

Naas Official Documentation. Contact us for more information about our early beta: [email protected]

site's Issues

Display of Company on the same line in footer

On site.naas.ai the footer section has Company below product when they should be on the same line.

Create .github directory

• The need arises in lieu of proper structuring of issue templates.
• Similar to this but cater to the needs of this repo.
• Preferably Bug report, Feature request, Docs, or Other inspired from this repo.

Bug: Render on hover properly and correct href's

• Inside the landing page, the Get started button on hover the text vanishes.

Screen.Recording.2023-05-31.at.6.51.13.PM.mov

• Make sure to redirect to the correct pages as per this comment.
• <h1> tag in all the docs pages is not rendered properly as per required.

Build error

Describe

Currently the docs/core-components/jobs/pipeline is producing the build error.

Expected behaviour

No response

Screenshots

No response

Additional context

No response

Update solutions section

Description

TDB

Additional context

No response

Reproduce the current landing page

Current state:






<img width="1678" alt="Screenshot 2023-05-03 at 10 11 47" src="https://user-images.githubuser

content.com/21052349/235863760-6eae0e11-ebb1-4e04-bd76-a6848faf9fa0.png">

Use Docusaurus standard footer

Describe

Right now we have 2 :

We would like the second one to look like the first one, and remove the first one (manually created).

Additional context

No response

Align Workspace font to Site font

Following Figma design it seems we have Monserrat for headings and Roboto for other stuff:
https://www.figma.com/file/9ADwSAxVu9xDUz5ajlZnWV/Naas-V2---Design?type=design&node-id=218-477&t=kCM1khC0AaagjcuZ-0

But let's make sure of this while comparing the 2 apps.

URL : https://www.figma.com/file/9ADwSAxVu9xDUz5ajlZnWV/Naas-V2---Design?type=design&node-id=218-477&t=kCM1khC0AaagjcuZ-0

Update Platform section

Describe

Update platform section with up to date information.

Screenshots

No response

Expected behaviour

No response

Change the pricing table for only monthly

We will do the yearly billing only when the beta is out.

Modify Getting started section to reflect the 3 type of usage

Basic: Leverage pre-designed templates as plugins within the myChatGPT platform to facilitate dialogue with a collection of AI models, each designed and pre-prompted for distinct use cases. These interactions emulate the role of the models in the given scenarios.

Intermediate: Employ templates as adjustable logical frameworks to establish a myChatGPT plugin, a feature that lets you directly engage with data. The customization capabilities of these templates offer the flexibility to cater to specific requirements and data formats.

Advanced: Adapt templates to function as integral parts of data products, providing a foundation for constructing comprehensive data interfaces such as dashboards and APIs, and further extending into the creation of sophisticated myChatGPT plugins. This advanced use of templates not only optimizes data visualization and accessibility but also enhances the overall user experience with custom plugins.

feat: Implement algolia search

Describe

The goal is to check how we can implement Algolia search in Docusaurus and if it's possible to link to with naas search.

Additional context

No response

Setup docusaurus external

Terms of Service & Privacy Page

Describe

On clicking on the Footer link, it shows blank page. Should we remove this link for now?

Expected behaviour

No response

Screenshots

No response

Additional context

No response

Sign in button on website

Describe

Sign in button needs to be in Primary color. The white button is not grabbing attention at all.

Expected behaviour

No response

Screenshots

No response

Additional context

No response

Fix: Spacing in blog

Describe

https://site.naas.ai/blog/ has improper text alignment

Expected behaviour

No response

Screenshots

Additional context

No response

Rename doc-external by site and setup domains + CI/CD

The purpose of this website is to serve as a landing page for my company, display pricing information, redirect users to the sign-up page on "workspace.naas.ai/login", host documentation, and provide a blog for the company.

Templates section update

Describe

Update templates section

Screenshots

No response

Expected behaviour

No response

Driver section update

Describe

Add intro page to driver

Screenshots

No response

Expected behaviour

No response

Create release candidate for the home page

Describe

A site ready for prime time here: https://www.figma.com/file/9ADwSAxVu9xDUz5ajlZnWV/Naas-V2---Design?type=design&node-id=2210-5090&mode=design&t=bZLQ4QDvuWJt5SYC-4

Screenshots

Expected behaviour

We should reuse the code base in "prerelease-alpha" and integrate it into this new branch.

Development environment

Describe

Describe the dev env

Screenshots

No response

Expected behaviour

No response

Update Space doc page

Describe

The current space doc page is actually the initial specs that we wanted to do. Now that the service is up let's update the docs with the following:

• short presentation of the service
• explanation of the low-code formulas
• workflows (docker → registry → create space → URL to be used)
• demo of a simple use case

Screenshots

No response

Expected behaviour

No response

Blog posts not visible in deployed version

Describe

I see 2 blogs in the github repo. But the deployed version has only one blog.

Expected behaviour

Screenshots

Screen.Recording.2023-07-28.at.8.27.15.PM.mov

Additional context

No response

Revamp sections which show product features.

Describe

Revamp these section

to be more like https://www.recko.io/automate-reconciliation-operations/

Additional context

No response

Remove highlighting from navbar dropdown

Right now it is like this:

Reproduce the current pricing page

Only the 2 below sections:

The FAQ will be handled in the docs section.

Fix: href's in the `Resources & Support`

Describe

Screen.Recording.2023-07-09.at.10.50.06.PM.mov

These links in the dropdown seem to be broken except the Blog.

Expected behaviour

No response

Screenshots

No response

Additional context

No response

Update get started

Describe

Update the get started section with up to date information.

Screenshots

No response

Expected behaviour

No response

WIP: Credit consumption monitoring for v2

Need for resource consumption monitoring

To be able to offer the lowest prices as possible for our customers we need to have a good tracking mechanism of what our users are consuming.

Today, multiple products are directly leveraging credits.naas.ai as soon as the consumption is happening. For example, when a user is interacting with a chat on workspace.naas.ai, as soon as we get back the completion from an LLM, we create a transaction that will then be stored in credits.naas.ai.

Handling that at the API level is fine for now, but in the future it would be better that those APIs just send the consumption event to a Kafka topic for example and then a consumer would take those events, link the resources consumed to a price sheet which can be generic or specific to the customer and then create and store the transaction. It would be easier to apply modification on pricing as the computation would happen in a consumer and won't be spread across multiple services.

With the new development, we are going to start deploying Cloud Provider resources:

• The registry api will for example create some ECR repository, that the user will have to pay for.****
• The space api will create Knative serving deployment, that will in turn deploy some containers in the Kubernetes cluster when some traffic is incoming.
  ...

What defines a consumption

To properly answer the need of following user consumption, we need to define every aspect of a user consumption.

The credits

First we have the "Credit", it's a value that can be bought using real world money. It's associated a price conversion to it so we can defined its price per dolars (or euros, etc...)

Users will buy credits through subscriptions that will then allow them to use our different services and features.

When reaching 0 credits, the user should not be allowed to consume anymore. At that point it should be possible for the user to have a way to buy more credits, either by changing subscription type, or any other available mean.

The services

At naas we have and will have multiple services, some are free, other are paid. Each service will consume different types of resources.

Space/Schedulers/Pipelines/Webhook will consume over time:

• CPU
• Memory
• Bandwith
• GPU

Registry will consume:

• over time:
  • Storage
• per container version:
  • Security scans

Notification will consume per request:

• Email/SMTP service (we use third parties)

Naas Chat will consume per message:

• LLM Tokens

Naas Storage will consume over time:

• Storage (S3)
• Bandwith read/write -> in/out (Download/Upload)

The prices

For each service we need to have a price conversion allowing us to know, based on the consumption data (CPU/Memory/Bandwith/GPU/Storage/Email/LLM Tokens/...) how much credits should be billed to the user.

The user prices

We have the need to have a standard pricing table, but we also need to be able to have user/organization specific pricing table as we may have different deals.

So it's important to be able to link a user_id to a sspecific service credit rate.

The events

So now that we defined the existence of services, credits and prices (credits / service) and users (credits / service / user), we must define a way to effectively create transactions based on user usage of the platform.

The complexity that we are faicing is that we want our platform to be deployable on multiple Clouds providers or even on premises, but also, each service that we are building may rely on multiple third parties technologies.

For exemple, Space/Schedulers/Pipelines/Webhook relies on Kubernetes, which is great because it's cloud agnostic. And we saw that those services will consume overtime:

• CPU
• Memory
• Bandwith
• GPU

But that's not all, 1vCPU on an intel Celeron or 1vCPU on an high end Xeon processor is not the same amount of CPU power, it goes the same for the memory, and the GPU. All of those are tied to a "machine type" which need to be know as well to be able to compute the right credits consumption.

To do that we need to emit "event" when the user is using paid services. On Kubernetes for example we can look for pod creations, what services it's coming from, what are the allocated resources, on which instance it's running and we need to send an event to a backend when we see that.

The event in itself won't be sufficient to know what is the real user consumption, indeed, in the case of the lifecycle of a container, it will be:

• Scheduled
• Pending
• Running
• Terminated

So in fact, we need to know the sequence of event to be able to compute the right credits consumption.

For Naas Chat it's simpler because it's transactionnal:

• User sends a message
• We send that message to the LLM
• The llm answers
• We compute the number of tokens
• We multiply tokens by token price and create a transaction.

It's also easy for Naas Notifications, where we know the price of an email so it's easy to track.

For Naas Reigstry it's more complex as we need to know when a registry is created, follow the size it takes, look for security scans, bill accordingly the user during the month. The registry today relies on AWS ECR but as we said earlier, we might need to handle different Container Registry provider based on the selected cloud provider.

For this we might need to emit events when something happens in the cloud provider. We might want, for AWS, to listen for Cloudtrail events, but it might not be sufficient, as we need to emit periodic event to know the state of the registry (size, etc).

The consumptions

The consumption will be triggered when a sequence of event reaches a state where we have a way to actually convert the event into a transaction.

For Space/Schedulers/Pipelines/Webhook we can do that when we have:

• CPU
• Memory
• Bandwith
• GPU
• Machine type
• Start time
• Stop time
• User id

At that time we will be able to store that actual consumption so the transaction will be able to be computed.

The transactions

Listening on the consumptions, we will then be able to get user prices and create the approriate transactions in credits.naas.ai api.

Kubernetes

The first need for us will be to monitor consumption in Kubernetes, indeed this is our primary source of user consumption (space, scheduler, lab).

I think that we should have a tool running in the cluster and watching for Kubernetes API events.

The role of this software would be to:

• Check what are the resources running and see if they are linked to a user account.
• Take the decision to keep the process alive or to shut it down if the user don't have enough credits remaining.
• Collect consumption information and create transactions in credits.naas.ai as soon as the consumption is ended.

What should be part of the compute of the consumption cost

Consumption in EKS should be measured based on time + kind of resources + amount of that resource + price. The kind of resources that we should monitor are:

• Allocated CPU
• Allocated Memory
• Allocated GPU
• Bandwidth usage
• Volume IOPS requested (this is not something we have configured yet but it should come)

Being also aware of the type of instance on which the resource was deployed could be interesting, at some point we will definitely want to know what was over provisioned in our infrastructure to allow us to serve our customer as this will be a source of cost optimization.

Cloud provider

For cloud provider monitoring, I think that it depends on the cloud provider, but we need to be able to link a resource to a user and watch for that resource periodically.

For resources that will be only be deleted through our API, these APIs can be responsible to store and update the required information. If at some point we have resources that can be removed automatically via the cloud provider, then we need to monitor what is happening as well on the APIs of the cloud provider. For example, with AWS, we could use AWS Cloudtrail to monitor creation/update/deletion of some resources that we know could be removed by the provider directly.

⚠️ To be continued.

Storage

We need to define a data format to store what is a resources, its link to a user and also its different states.

⚠️ To be continued.

Prepare Deck to present Naas + Nebari Integration

Objective: explain how we see the integration with Nebari and our Terragrunt approach for multi-cluster deployment.

Google slides TBD

Enhance Data Product Workflow Page

Describe

Combine the work done on this notion page with the current page:

The idea is to have on page that enables everyone to understand how to develop a data product.
That's why we need to rename first the page to "Data Product Development"

Then, shoot loom videos on each of the following subjects:
https://www.notion.so/Naas-Lab-74eaf70c2fa14109bfc5a023353cb091

Screenshots

No response

Expected behaviour

We should have videos on the page for each subject.

Syntax highlight code blocks

Current:

Expected:

• Display the code block with syntax highlighter. Similar to this but for Python.
• Needs a few modifications in the docusaurus.config.js to preview the changes.

Reference

Update sites with usage policy about Lab

On Naas Lab, the server will be automatically shut down for Free users after 72 hours if there are active jobs running, or after 1 hour of inactivity if no jobs are detected.

Section Enhance with Logo's

Describe

Lets revamp this section

to look more like. https://www.intercom.com/

Additional context

The logo's will be moving and its a loop giving an illusion of never ending brand list. More references: https://www.chatfood.io/

Add all templates inside Templates section

following what's already done in CI/CD by @Dr0p42 where at each update of the repo, we want the docs to get updated, we would like to migrate that system here in: /docs/category/templates where each folder is a tool and each notebook is a markdown page

@srini047 do you think you can try to reuse what @Dr0p42 has done?

Fix home screen layout responsiveness

Describe

The current home screen is not well aligned in mobile screens.

Expected behaviour

The text should alignment and sizes must be fixed in smaller devices. Improve padding and spacing between items

Screenshots

No response

Additional context

No response

Update navbar

Add "Documentation" and "Blog" section in header (left next to logo) + "Sign up" & "Login" (right)
We should use the current navbar setup from docusaurus to have that kind of display where Signup & Login are below "Documentation" and "Blog":

Update documentation v2

Describe

https://site.naas.ai should be ready for communication to contributors

We are basically missing:

• A video on each page
• A search to find information easily
• A rewrite of the Data Product Development workflow

Screenshots

No response

Expected behaviour

No response

Data product framework update page

Describe

• introduction
• why you should build data products?
• what you need to think about : templates → combined to build data products
• how you can kickstart : clone the data-product-framework repo
• how to construct a readme for your data product (the user manual)
• how to organize your folders (explain each folder in part)
  -- how to manage data storage (low volume: ok naas server)
• how to integrate a feedback loop on the repo (issues/PR, project board)
• how to push to production on your server
• how to monitor your execution
• how to deploy your data product on a serverless instance

Screenshots

No response

Expected behaviour

No response

Update design of the docs pages.

Description

Right now the font do not look right. We need to come back to the original Docusaurus.

Additional context

No response

Title and Button placement

Describe

The title along with description and button below is not aligned on page properly.

Expected behaviour

In the whole website, we are suing center alignment. Lets maintain consistency.

Screenshots

No response

Additional context

No response

Integrate current docs and adapt to v2 vision

The idea is to integrate the current docs page with the v2 vision in mind.

Section - Align to center

Describe

The below shown section should be placed in center of the page rather than left aligned.

Additional context

Other sections similar to this needs to be center aligned as well.

Fix billing

Description

go to yearly, should go monthly

Additional context

No response

Make site repo run on codespace

Describe

Today I have a 404 page not found after docker-compose up

Expected behaviour

I would like to do a simple make command and run the project on codespace for quicker contribution process than if I need to setup locally with vs code.

Screenshots

Additional context

No response

Update: href's

Current:

Expected:

This has to be ensured to render properly as expected similar to this one.

Buttons corner Radius

Describe

Lets maintain the corner radius for all buttons. Here the Sign in buttons has different radius value where as other have less radius corners. Can we make it all same.

Expected behaviour

No response

Screenshots

No response

Additional context

No response

Sign In button In middle of Website

Describe

Sign In button after Discover Naas Lean Data Section needs a Heading or something as it seems very floating. May be a header or shift it above the logos.

Additional context

No response

Make sure that Navbar is aligned with v2 target

We want to have a section on the left with:

same color as the body of the website

on the right we want :

• Search instead of GitHub going to workspace.naas.ai/search
• Login: button same as v1 but going to workspace.naas.ai/auth/login
• Get Started: button same as v1 but going to workspace.naas.ai/auth/signup

Add break line to improve readability

Describe

Paragraph blocks are hard to read in Templates, Drivers and Data Product Framework page

Screenshots

Expected behaviour

No response