Skip to content

Commit 23547ed

Browse files
committed
Fixed broken issues with document
1 parent 8d1221a commit 23547ed

5 files changed

+109
-16
lines changed

docs/project-creating-your-own.md

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
id: nim-creating-project
3+
title: Creating your project
4+
sidebar_label: Creating your project
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
### Creating your project template with the Nimbella CLI
10+
11+
With the Nimbella CLI, you can create a project template that you can use to instantly start building your project.
12+
13+
To create a project template, run this command in your command prompt:
14+
15+
```
16+
nim project create folder_name
17+
```
18+
19+
After running this command in your command prompt, you should see a message saying your project folder is available.
20+
21+
<img alt="Docusaurus with Keytar" src={useBaseUrl('static/img/nim-project-create-ex.png')} />
22+
23+
### Creating a YAML file for your project
24+
25+
**NOTE**: What makes Nimbella standout is that you don't need a YAML file for most simple projects. But if you want to customize specific things you are deploying, you can build a `.yml` file for it.
26+
27+
To generate a `.yml` file when you create a project. Run the command:
28+
29+
```
30+
nim project create folder_name --config
31+
```
32+
33+
The `--config` flag tells the CLI to generate a `.yml` template you can use for your project. You should see this template inside of your project folder:
34+
35+
```
36+
targetNamespace: ''
37+
cleanNamespace: false
38+
bucket: {}
39+
parameters: {}
40+
environment: {}
41+
packages:
42+
- name: default
43+
shared: false
44+
clean: false
45+
environment: {}
46+
parameters: {}
47+
annotations: {}
48+
actions:
49+
- name: hello
50+
clean: false
51+
binary: false
52+
main: ''
53+
runtime: 'nodejs:default'
54+
web: true
55+
webSecure: false
56+
parameters: {}
57+
environment: {}
58+
annotations: {}
59+
limits: {}
60+
```
61+
62+
### Basics of the project structure.
63+
64+
After creating the project folder, you'll see that it contains two folders. A `web` folder to add directories and files with static web content and a `packages` folder to create serverless functions.
65+
66+
[Click here to learn more about the project structure you just created.](https://github.com/nimbella/docs/blob/master/docs/projects.md)

sidebars.js

+43-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,45 @@
11
module.exports = {
2-
someSidebar: {
3-
"Introduction": ["welcome", "what-is-nimbella", "serverless", "serverless-vs-server", "serveless-apps", "why-nimbella", "account", "features", "openwhisk"],
4-
"Nimbella Project": ["deployer-overview", "projects", "namespaces", "actions", "project", "configuration", "deployer-feature", "single-action", "namespace-to-projects"],
5-
"Serverless SDK": ["key-value-sdk", "file-stores"],
6-
"Runtime & Languages": ["runtime"],
7-
"CLI": ["install", "commands", "flags", "command-summary", "wsk"],
8-
"Workbench": ["workbench"],
9-
"Getting Started": ["getting-started", "building"],
10-
"Developing and Deploying Serverless APIs": ["sample-project-walkthrough"],
11-
"Developing & Deploying Web": ["web", "web-content"],
12-
"Taking your application to production": ["production"],
13-
"Integrations": ["commander", "postman", "netlify"],
14-
"Porting existing applications onto Nimbella": ["heroku", "express", "django", "flask", "lambda", "openwhisk-port"],
15-
Docusaurus: ['doc1', 'doc2', 'doc3'],
16-
Features: ['mdx'],
17-
},
2+
someSidebar: {
3+
Introduction: [
4+
'welcome',
5+
'what-is-nimbella',
6+
'serverless',
7+
'serverless-vs-server',
8+
'serveless-apps',
9+
'why-nimbella',
10+
'account',
11+
'features',
12+
'openwhisk',
13+
],
14+
'Nimbella Project': [
15+
'deployer-overview',
16+
'projects',
17+
'namespaces',
18+
'actions',
19+
'project',
20+
'configuration',
21+
'deployer-feature',
22+
'single-action',
23+
'namespace-to-projects',
24+
],
25+
'Serverless SDK': ['key-value-sdk', 'file-stores'],
26+
'Runtime & Languages': ['runtime'],
27+
CLI: ['install', 'commands', 'flags', 'command-summary', 'wsk'],
28+
Workbench: ['workbench'],
29+
'Getting Started': ['getting-started', 'building', 'nim-creating-project'],
30+
'Developing and Deploying Serverless APIs': ['sample-project-walkthrough'],
31+
'Developing & Deploying Web': ['web', 'web-content'],
32+
'Taking your application to production': ['production'],
33+
Integrations: ['commander', 'postman', 'netlify'],
34+
'Porting existing applications onto Nimbella': [
35+
'heroku',
36+
'express',
37+
'django',
38+
'flask',
39+
'lambda',
40+
'openwhisk-port',
41+
],
42+
Docusaurus: ['doc1', 'doc2', 'doc3'],
43+
Features: ['mdx'],
44+
},
1845
};

static/img/7a-nim-project-create.png

19.4 KB
Loading

static/img/kv-store-redis-example.png

179 KB
Loading

static/img/nim-project-create-ex.png

19.4 KB
Loading

0 commit comments

Comments
 (0)