Tie the docs together

Rename docs

Move apache docs

Deploy to Nimbella

Make the site document-only

Use proper casing

Organization and auto-gen improvements to command doc (nimbella#12)

* Minor fixes in case we end up using this material

* WIP for the command reference document

* Improve auto-gen. of nim doc and break up further

* Adjust structure to align with current sidebar

The sidebar is subject to change, of course, but for now I need to just
accept it as is while working on documents.

* Correct typos that broker docusaurus build

* Lower severity on broken links

A local build with this change did not complain of a broken link and
following the links in question actually works.  So I'm not sure what's
going on here but lowering the severity to get through the checks at
push time.

* Update apache-based/README.md

Co-authored-by: rodric rabbah <[email protected]>

* Update apache-based/README.md

Co-authored-by: rodric rabbah <[email protected]>

Co-authored-by: rodric rabbah <[email protected]>

multi tab code example (nimbella#13)

Remove language specific docs (nimbella#14)

Re-run the generator after fixing repo type bug (nimbella#16)

Add contribution guide (nimbella#15)

Document programming with "file stores" (aka object stores or blob stores) (nimbella#11)

* WIP for object stores document

* More progress on what is now called "file stores"

* Change file names so that the docs are reachable

This is probably not quite right for two reasons.  (1) The document is
broader than just the SDK.  (2) I have chosen to use the term file
store rather than object store.  The document could change further to
conform to the TOC but I want to at least raise the possibility that
it's the TOC that should change.

* Trying again to connect the new document properly

This time I did amend the sidebar contents.  I think the new document
subsumes what was "web SDK" and "object SDK".

* Still figuring out docusaurus

Just trying to get the sidebar to refer to my document properly.

* Still tinkering

* Apply suggestions from code review

Committing many (thought not all) of Rodrics' suggestions.

Co-authored-by: rodric rabbah <[email protected]>

* WIP on file-stores document

* Finish a reviewable draft of the file-stores doc

Co-authored-by: rodric rabbah <[email protected]>

finalized fixes for this basic KV example doc

removed > from output example

Some examples explaining how to use Nimbella KV (nimbella#18)

Additional documentation for the Nimbella KV (nimbella#23)

Workbench documents - Sections 12 & 13 of issue 862 (nimbella#22)

Updated sentence and removed bad link.

checked pages

Some examples explaining how to use Nimbella KV (nimbella#18)

Additional documentation for the Nimbella KV (nimbella#23)

Workbench documents - Sections 12 & 13 of issue 862 (nimbella#22)

Updated sentence and removed bad link.

removing items

removed all empty files

finalized fixes for this basic KV example doc

removed > from output example

Some examples explaining how to use Nimbella KV (nimbella#18)

Additional documentation for the Nimbella KV (nimbella#23)

Workbench documents - Sections 12 & 13 of issue 862 (nimbella#22)

Updated sentence and removed bad link.

checked pages

Some examples explaining how to use Nimbella KV (nimbella#18)

Additional documentation for the Nimbella KV (nimbella#23)

Workbench documents - Sections 12 & 13 of issue 862 (nimbella#22)

Updated sentence and removed bad link.

removing items

removed all empty files

Basic KV usage (nimbella#24)

Project create example (nimbella#26)

Deploy from GitHub (nimbella#28)

.gitignore

@@ -8,6 +8,9 @@
 .docusaurus
 .cache-loader
 
+# Nimbella
+.nimbella
+
 # Misc
 .DS_Store
 .env.local

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,116 @@
+### Contributing to the Nimbella Documentation
+
+We are thankful that you're taking the time to read this contribution guide, and we are excited to work with you toward a positive contribution to the project.
+This document outlines the process for contributing to the project.
+
+### We welcome all contributions.
+
+Contributions come in many different forms, not just code. Here are some quick tips:
+- **Improving documentation**: If you found a typo, just make a pull request with the fix.
+- **Adding new documentation**: If you are planning to write new documentation, please [open an issue first](../../issues/new/choose). This gives us a chance to provide guidance when necessary.
+- **Requesting a new documentation**: [Open a "Feature Request"](../../issues/new?template=feature_request.md) and fill out details appropriately.
+- **Changing existing documentation**: Please open an appropriate [issue](../../issues/new/choose) describing your proposed change before you create a pull request. This ensures consensus and allows us to work together toward positive outcomes.
+
+### Contribution guidelines.
+
+Please review and keep the following guidelines in mind. _If this is your first time contributing to an open source project on GitHub, we recommend this [video series](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github) to learn how to contribute._
+- We have a [Code of Conduct](CODE_OF_CONDUCT.md), please review it so you are familiar with the project values.
+- You agree that your contributions will be licensed under the [Apache 2.0 License](LICENSE).
+- When you open a pull request with your contributions, **you are certifying that you wrote the code** in the corresponding patch pursuant to the [Developer Certificate of Origin](#developer-certificate-of-origin) included below for your reference.
+- If you're contributing a new document, the [guide below](#creating-a-new-document) wil help you get started.
+
+### Contact us.
+
+We're always happy to help you with any issues you encounter. You may want to [join our Slack community](https://nimbella-community.slack.com/) to engage with us for a more rapid response.
+
+---
+
+### Creating a new document
+
+Let's create a new document `greetings`
+
+##### 1. Fork this repo & clone it.
+
+```sh
+$ git clone https://github.com/<username>/docs
+```
+
+##### 2. Create a new file named `greetings.md` inside the `docs` repository and under the docs folder.
+
+```sh
+$ cd docs && touch docs/greetings.md
+```
+
+##### 3. Add documentation content to the file
+
+```sh
+---
+id: greetings
+title: About Greetings
+sidebar_label: About Greetings
+---
+
+## Information about the greeting
+## Content about greeting
+```
+
+##### 5. Add the new document to sidebar.js
+
+```sh
+  Greeting: ['greetings']
+```
+The document is mapped to the sidebar by the id of the document as shown above
+
+---
+
+##### 6. Test the changes locally
+
+```sh
+  yarn install
+  yarn start
+```
+The start command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server
+
+---
+
+### Developer Certificate of Origin
+
+```
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.
+```