search

nimbella / docs

Apache License 2.0
3 stars 9 forks source link

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

Closed JamieDawson closed 3 years ago

JamieDawson commented 3 years ago

Here are the workbench documents from https://github.com/nimbella-corp/nimbella-cli/pull/327 Per @joshuaauerbachwatson, request, I have created a new pull request in this repo.

12-13

joshuaauerbachwatson commented 3 years ago

Since we are in phase of just getting some missing documents drafted, I'm not going to pick a lot of nits. All of our documents will likely be wordsmithed and revised going forward.

But, I'd like to see two things corrected before I merge this:

  1. There are broken image links in workbench-playground-1-intro.md. The images should be in the repo and the links should be relative.
  2. The document workbench-playground-3-deploy-from-github.md is misnamed. It is about a workbench feature but not a playground feature.

I also note (@JamieDawson, you don't have to fix this prior to merge) that these documents are not connected to the top-level structure in the sidebar. I will do something about that after the merge. I believe all of our documents should be connected to "the structure" even though we are pretty likely to revise that structure extensively as the work progresses.

JamieDawson commented 3 years ago

@joshuaauerbachwatson

There are broken image links in workbench-playground-1-intro.md. The images should be in the repo and the links should be relative.

Lately, I've just been uploading my images to Flickr and then getting the links from there. Do you believe we should create an images folder and collectively start adding the images there?

rabbah commented 3 years ago

We should put the images into our/this repo - is there a reason to use flickr? If not our repo then i would use a nimbella bucket instead, which is also something we control.

joshuaauerbachwatson commented 3 years ago

Lately, I've just been uploading my images to Flickr and then getting the links from there. Do you believe we should create an images folder and collectively start adding the images there?

There would be no need to create another images folder. There already is one in static/img in this repository. When @niks3089 moved things over from newdoc and established the new structure, he put the images from some of my documents there, alongside some docusaurus ones, so I just assumed we'd continue that convention.

In fact, I am open to other possibilities but the links you have there now don't work (at least they didn't for me). And I think it is important to be consistent. So, I believe you should put your images in static/img for now and we can separately discuss alternatives as things evolve.

JamieDawson commented 3 years ago

There are broken image links in workbench-playground-1-intro.md. The images should be in the repo and the links should be relative.

Images added to static/img. Thank you for addressing that. I will no longer us Flickr.

The document workbench-playground-3-deploy-from-github.md is misnamed. It is about a workbench feature but not a playground feature.

Renamed file.

rabbah commented 3 years ago

@JamieDawson please link these docs to the side bar.

JamieDawson commented 3 years ago

1) Documents are linked in the sidebar. 2) A git rebase and git diff origin/workbench-documents was applied to this repo for completion.

Document ready for review.

JamieDawson commented 3 years ago

All image fixes Rodric requested have been applied. Pending review.

JamieDawson commented 3 years ago

Hey @rabbah , I believe I made a mistake with this. After fixing the error "GitHub this branch has conflicts that must be resolved" which was above this post. I clicked the "Squash and merge" button not realizing I could do that on my own. I was under the impression that it would need a 2nd person to ok the merge request.

rabbah commented 3 years ago

It's OK. If there are remaining issues, you can handle them in another PR. (We haven't enabled checks yet for convenience and you have write privileges hence you can merge your own PRs at this time.)