Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

7a - nim project create - for issue #862 #26

Merged
merged 4 commits into from
Jan 5, 2021
Merged

7a - nim project create - for issue #862 #26

merged 4 commits into from
Jan 5, 2021

Conversation

JamieDawson
Copy link
Contributor

Here is a document for 7a. nim project create.

7a nim project create

rabbah
rabbah reviewed Dec 8, 2020
View reviewed changes
Copy link
Contributor

@rabbah rabbah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

check references to images that are fully qualified and referring to your fork - please replace those with local/relative links.

docs/key-value-storage.md Outdated

In this visual example, you can store user info, such as their City, State, and Country, and apply the correct values to them. This allows you to keep track of data and request the data when needed.

![](https://github.com/JamieDawson/docs/blob/10b-two-types-storage-kv/static/img/kv-store-redis-example.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is referring to your fork. instead use a relative link ./docs/... so that it works for anyone's fork.

@JamieDawson JamieDawson force-pushed the 7a-nim-project-create branch from 99dd700 to 23547ed Compare December 16, 2020 00:25
@JamieDawson
Copy link
Contributor Author

JamieDawson commented Dec 16, 2020 •
edited
Loading

Issues fixed in this document:

  1. Deleted key-value-storage.md file. That file isn't supposed to be in here.
  2. Fixed broken images and replaced them with local ones.
  3. Attached document to sidebar.
  4. git rebased all commits to one.

Pending Re-review.

rabbah
rabbah reviewed Dec 17, 2020
View reviewed changes
Copy link
Contributor

@rabbah rabbah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file static/img/7a-nim-project-create.png is not used in this PR?

rabbah
rabbah reviewed Dec 17, 2020
View reviewed changes
Copy link
Contributor

@rabbah rabbah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also "7a" has no meaning in this repo. Should use a different naming convention (here just drop it.

@JamieDawson
This is probably not quite right for two reasons. (1) The document is
cc41b98 
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]>

Fixed broken issues with document

removed image and changed repo name

parent 25b7ed1
author JamieDawson <[email protected]> 1608679644 -0800
committer JamieDawson <[email protected]> 1608681398 -0800

Fixed broken issues with document

removed image and changed repo name

Additional documentation for the Nimbella KV (nimbella#23)

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

Updated sentence and removed bad link.

fixed sidebar.js error

cant rebase

Fixed broken issues with document

removed image and changed repo name

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.
@JamieDawson JamieDawson force-pushed the 7a-nim-project-create branch from f34ec7a to cc41b98 Compare December 23, 2020 00:57
@JamieDawson
Copy link
Contributor Author

All changes applied.

@JamieDawson JamieDawson added this to the Merge existing PRs milestone Dec 30, 2020
@JamieDawson
Copy link
Contributor Author

File that needs to be checked:
Getting started ---> Creating your project

rabbah
rabbah reviewed Jan 5, 2021
View reviewed changes
sidebars.js Outdated Show resolved Hide resolved
@rabbah rabbah merged commit 8f0ecda into nimbella:master Jan 5, 2021
@rabbah
Copy link
Contributor

rabbah commented Jan 5, 2021

@JamieDawson I merged this PR but this one is relevant to the discussion in #30 as the reference docs for projects is currently not linked to this "how to" but should be so that a reader can dig into the details they will eventually need.

JamieDawson pushed a commit to JamieDawson/docs that referenced this pull request Jan 8, 2021
@niks3089 @JamieDawson
Tie the docs together
ea12707 
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rabbah rabbah rabbah approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Merge existing PRs - Jamie's docs.
Development

Successfully merging this pull request may close these issues.
2 participants
@JamieDawson @rabbah