Skip to content

Commit

Permalink
Merge pull request #147 from chenzhitong/errortitle
Browse files Browse the repository at this point in the history
fixed error title
  • Loading branch information
Celia18305 authored Sep 14, 2024
2 parents 37c3c9e + 74ecf0f commit 7cefa98
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 96 deletions.
10 changes: 2 additions & 8 deletions docs/n3/Advances/neofs/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
---
title: 'Neo FS Go SDK Documentation'
description: "This section covers the elements of NeoFS and the NeoFS SDK written in Go"
author: ngdenterprise
tags: [ "NEOFS"]
skill: intermediate
sidebar: true
---
# Neo FS Go SDK Documentation

## Neo Community Documentation

Please join us on the Neo discord server if you would like any support and please contribute back if you have something to add!
Expand Down
19 changes: 8 additions & 11 deletions docs/n3/Advances/neofs/introduction/Concepts.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,40 @@
---
title: "Concepts"
date: 2022-01-18T21:13:48Z
---
# Concepts

NeoFS is very carefully designed to offer the power of a filesytem with all the expected capabilities, on top of a decentralised network.

This means that files/folders etc can have permissions to who can read/write to them who can delete etc etc.

As NeoFS is built on top of the Neo blockchain, these permissions are based on wallet addresses of users.

### Objects
## Objects

[Objects](/docs/n3/neofs/topics/objects) represent all files/data that is stored on NeoFS. Objects are accessed via SessionTokens or Bearer Tokens

### Containers
## Containers

A [container](/docs/n3/neofs/topics/containers) controls the basic permissions that are applied to all content within it. Think of a container like a drive on a computer or network (and not a folder per se).

All objects must live within a container, their permissions will default to the permissions of the container

### OwnerID
## OwnerID

OwnerID is derived from the public or private key of a wallet and is unique to that wallet.

### Policies
## Policies

Container policies define the way objects will be placed among storage nodes. That is, you as the container owner can decide what type of node should store a file for you.

### EACL
## EACL

Containers and sessions/bearer tokens can have differeing permissions. By default permissions will be the same as the container's however if permissions are attached as a table to the container, or a bearer token is sent as part of a request, then they can override the permissions of the container

Read more about [ACL here](https://github.com/nspcc-dev/neofs-spec/blob/master/01-arch/07-acl.md)

### Access
## Access

Access is made using session tokens (derived from the private key), or bearer tokens, which are distributed by the container owner to others they want to be able to offer restricted capabilities (and time limits) to other users

### Wallets
## Wallets

A wallet is specifically an item that takes the NEP-6 format and contains any number of accounts. Accounts contain a public address, a private key and other information (read more here)

Expand Down
5 changes: 1 addition & 4 deletions docs/n3/Advances/neofs/introduction/Libraries.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
---
title: "Libraries"
date: 2022-01-18T21:13:48Z
---
# Libraries

The Go SDK is the basis of all the functionality that is available to you as a developer with regards to NeoFS.

Expand Down
13 changes: 5 additions & 8 deletions docs/n3/Advances/neofs/introduction/Overview.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
---
title: "Overview"
date: 2022-01-18T21:13:48Z
---
# Overview

This chapter outlines the [concepts](/docs/n3/neofs/introduction/concepts) and top level points required to understand and enjoy building on neo & NeoFS

### Starting out
## Starting out

The topics here are primarily in Go, however where we have code snippets for other languages we will endeavour to add them.

Expand All @@ -31,14 +28,14 @@ This documentation is not a tutorial, it is a reference to using the SDK, howeve
5. To do so however, you will need a session token (or a bearer token but start with a session token). The session token contains a signature that validates your wallet against NeoFS.
6. You might create a container, put an object in a container, or delete an object.

### Libraries
## Libraries

[Libraries](/docs/n3/neofs/introduction/libraries) covers the packages and libraries that are required to interact with Neo and NeoFS in Go

### References
## References

* [neofs-spec](https://nspcc.ru/upload/neofs-spec-latest.pdf#13)

### With Thanks To
## With Thanks To

* [NSPCC team](https://github.com/nspcc-dev/) - team behind NeoFS, the [neo-go-sdk](https://github.com/nspcc-dev/neofs-sdk-go) and the [neo-go](github.com/nspcc-dev/neo-go) packages
10 changes: 1 addition & 9 deletions docs/n3/Advances/neofs/topics/acl-permissions.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
---
title: "ACL Permissions"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# ACL Permissions

NeoFS has an awesome set of permissions you can give to containers.

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/clients.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Clients"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Clients

There are two types of client to be aware of and as they are both clients it can get confusing. You have a wallet client and an NeoFS client.
Interactions with NeoFS will require a NeoFS client, whereas wallet actions will require a wallet client. Note they do not reside in the same package
Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/containers.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Containers"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Containers

Containers manage the permissions/access of a group of objects that are being stored. Before being able to store an object, you need to create a container.

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/helpers.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Helper functions"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Helper functions

There are some functions that don't quite fit into another topic. They will be referenced as `helper.X` in other topics

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/objects.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Objects"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Objects

Objects represent items stored within a [container](/docs/n3/neofs/topics/containers). These are subject to the permissions of the container being the most relaxed possible permissions that can be applied to an object. It is possible using [Session/Bearer Tokens](/docs/n3/neofs/topics/tokens) to restrict permissions further on objects within a container however

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/policies.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Policies"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Policies

Before we can create a container, we need to define the policy. A policy defines which storage nodes on NeoFS you are happy to store your data on.

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/tokens.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Tokens"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Tokens

Tokens are required to act on any [objects](/docs/n3/neofs/topics/objects) within a [container](/docs/n3/neofs/topics/containers). Sessions last for limited time and are restricted by permissions. [Session tokens](/docs/n3/neofs/topics/tokens) use the private key to sign them while [bearer tokens](/examples/tokens) are issued to wallets by a container owner.

Expand Down
9 changes: 1 addition & 8 deletions docs/n3/Advances/neofs/topics/wallets.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
---
title: "Wallets"
date: 2022-01-18T21:13:48Z
---

import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Wallets

Almost everything you may want to do with NeoFS will require access to a wallet. Here are a few handy ways to get a wallet

Expand Down

0 comments on commit 7cefa98

Please sign in to comment.