generated from layer5io/layer5-repo-template
-
Notifications
You must be signed in to change notification settings - Fork 85
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
Create design from scratch and added docker target in makefile #97
Merged
theBeginner86
merged 7 commits into
layer5io:master
from
vaibhavpnimkar:create-design-from-scratch
Dec 28, 2023
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
33ea1fd
Added docs for creating design from scratch
vaibhavpnimkar a831adc
adding target docker in makefile
vaibhavpnimkar 1cb096b
Merge branch 'layer5io:master' into create-design-from-scratch
vaibhavpnimkar b94cc3b
changed title
vaibhavpnimkar e8479d3
Merge remote-tracking branch 'origin/create-design-from-scratch' into…
vaibhavpnimkar b3fb36e
updaing docs and updating docker example to docsy
vaibhavpnimkar 80a69a8
rm redundant make targets
theBeginner86 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,9 @@ | ||
FROM klakegg/hugo:ext-alpine | ||
# Use floryn90/hugo:ext-alpine as the base image | ||
FROM floryn90/hugo:ext-alpine | ||
|
||
RUN apk add git && \ | ||
git config --global --add safe.directory /src | ||
# Set the working directory to /src | ||
WORKDIR /src | ||
|
||
# Install Git and configure safe directory | ||
RUN apk add --no-cache git && \ | ||
git config --global --add safe.directory /src |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,10 @@ | ||
version: "3.3" | ||
version: '3' | ||
|
||
services: | ||
|
||
site: | ||
image: docsy/docsy-example | ||
build: | ||
context: . | ||
command: server | ||
hugo: | ||
image: floryn90/hugo:ext-alpine | ||
ports: | ||
- "1313:1313" | ||
volumes: | ||
- .:/src | ||
command: server --buildDrafts --buildFuture --bind 0.0.0.0 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this but this deviates from the idea of documentation. Reason being that it tells users what they need to do rather than the underline system behavior for each of their actions.
Would you please consider updating this?
Ideally, you need to answer questions like what happens when a user create a new design, what's the visibility of the design, what's the meaning of that visibility (lightly), does naming/renaming a design creates a new design copy or updates the original name, how users would be seeing different versions of the desired Meshery Model components, what happens internally when user merge a design, does user loose one of their design in the process, how does it affect the visibility of the merged design, etc....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay noted !!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should i consider adding images for each action ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, if in doing so, you are describing the underlying system behavior. No, if you are simply giving the user a step-by-step series of instructions about how to click through the UI. If we have to provide them the step-by-step series of instructions on how to click through the UI, then we have failed our UX test, and I need to make UX changes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay i almost got it @leecalcote will update soon !!