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.

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

Simplify README and transfer content, also new content Spin/Bart using website template #110

Merged
merged 8 commits into from
Aug 26, 2022

Conversation

tpmccallum
Copy link
Contributor

@tpmccallum tpmccallum commented Aug 24, 2022

This is a PR which is the beginning of creating a single source of truth for the Bartholomew docs.
Essentially, remove content from the readme.md file and place that content in the official docs (in the relevant spots/files).
Also updated the documentation to reflect that Spin exclusively creates a new site (and can do so using a template) and that Bart will no longer be performing this sort of task.

The initiative for this change
The conversation about the idea to simplify the README.md can be found here.

The tests in relation to this change

Preview
spin up -e "PREVIEW_MODE=1"

Screen Shot 2022-08-24 at 5 10 25 pm

Bart check
bart check

Screen Shot 2022-08-24 at 5 09 43 pm

Signed-off-by: tpmccallum mistermac2008@gmail.com

…g website template

Signed-off-by: tpmccallum <mistermac2008@gmail.com>
Copy link
Member

@mikkelhegn mikkelhegn left a comment

Choose a reason for hiding this comment

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

There's a single "bug" around the bartholomew spin template which should be fixed. Everything else is just feedback and not blocking.

docs/.gitignore Show resolved Hide resolved
docs/content/contributing.md Show resolved Hide resolved
docs/content/contributing.md Outdated Show resolved Hide resolved
docs/content/contributing.md Outdated Show resolved Hide resolved
docs/content/contributing.md Outdated Show resolved Hide resolved
docs/content/contributing.md Show resolved Hide resolved
docs/content/contributing.md Outdated Show resolved Hide resolved
docs/content/contributing.md Outdated Show resolved Hide resolved
docs/content/markdown.md Outdated Show resolved Hide resolved
docs/content/quickstart.md Outdated Show resolved Hide resolved
@tpmccallum
Copy link
Contributor Author

Awesome feedback, thank you @mikkelhegn
I will attend to all of these, much appreciated.

The spin templates install bug is interesting, I will look into that; not sure why that is happening.

@itowlson
Copy link
Contributor

There's no spin templates install bug here - the site template is a GitHub template (for GH repos), not a Spin application/component template. It's correct that Spin finds no Spin templates in the GH repo template.

@itowlson
Copy link
Contributor

(There is of course no reason we couldn't create a Spin template for a Bartholomew web site. But this isn't that.)

@tpmccallum
Copy link
Contributor Author

Thank you Ivan @itowlson
Given that the bartholomew-website-template is not a Spin application/component template I will just go ahead and clone the template and then run Spin commands from within.

@itowlson
Copy link
Contributor

People creating sites would not clone the template I think - they would use the template to create a new repo.

https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template

(obviously if the article is about working on the template itself then yes, fork and clone)

Signed-off-by: tpmccallum <mistermac2008@gmail.com>
@tpmccallum
Copy link
Contributor Author

Hi @mikkelhegn and @itowlson
Thanks a million for your suggestions, all great. Keen eyes!
These have all been resolved in the 47adbae commit.
Thanks
Tim

docs/content/quickstart.md Outdated Show resolved Hide resolved
docs/content/quickstart.md Outdated Show resolved Hide resolved
docs/content/quickstart.md Outdated Show resolved Hide resolved
Signed-off-by: tpmccallum <mistermac2008@gmail.com>
Signed-off-by: tpmccallum <mistermac2008@gmail.com>
Signed-off-by: tpmccallum <mistermac2008@gmail.com>
@tpmccallum
Copy link
Contributor Author

Please note, that those changes have been actioned in the last few commits.
Thanks again and happy for more feedback also. Very helpful.

Signed-off-by: tpmccallum <mistermac2008@gmail.com>
Signed-off-by: tpmccallum <mistermac2008@gmail.com>
Copy link
Member

@mikkelhegn mikkelhegn left a comment

Choose a reason for hiding this comment

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

Looks like the .DS_Store files are now checked-in, in a few places?

Signed-off-by: tpmccallum <mistermac2008@gmail.com>
@itowlson itowlson dismissed their stale review August 26, 2022 01:15

Changes I asked for are done, but don't feel confident to approve

README.md Show resolved Hide resolved
@tpmccallum tpmccallum merged commit 118b074 into fermyon:main Aug 26, 2022
@tpmccallum
Copy link
Contributor Author

Thanks @radu-matei glad to wrap this one up.
Thanks, @itowlson @mikkelhegn @karthik2804 that was a good amount of reviewing; much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants