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

Update README.md #107

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Update README.md #107

wants to merge 10 commits into from

Conversation

shivan
Copy link

@shivan shivan commented Nov 17, 2020

more details for XSite example

fixes #106

more details for XSite example
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@pruivo
Copy link
Member

pruivo commented Nov 17, 2020

do you mind adding the config1.yaml and config2.yaml? any new user seeing those commands may not understand where the configuration comes from.

@pruivo pruivo requested a review from oraNod November 17, 2020 16:25
more generic

Co-authored-by: Pedro Ruivo <[email protected]>
@pruivo
Copy link
Member

pruivo commented Nov 17, 2020

@oraNod when you have time, can you take a look?

more generic

Co-authored-by: Pedro Ruivo <[email protected]>
@shivan
Copy link
Author

shivan commented Nov 17, 2020

do you mind adding the config1.yaml and config2.yaml? any new user seeing those commands may not understand where the configuration comes from.

good Idea, I'll add it to the readme, too

added config1 + 2
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
shivan and others added 6 commits November 18, 2020 16:01
clarify description

Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Don Naro <[email protected]>
Co-authored-by: Pedro Ruivo <[email protected]>
@oraNod
Copy link

oraNod commented Nov 18, 2020

@pruivo and @ryanemerson I've been thinking about this a little more and wonder if this readme is the right place for these xsite-details? This feels a little bit like the simple-tutorial that already uses the image. I don't wish to discourage any contributions but wonder if there is potential to bloat the readme, duplicate content, add maintenance overhead? Basically is this content being added to the right place?

@ryanemerson
Copy link
Collaborator

First of all, thanks for the contribution @shivan much appreciated.

@oraNod I agree that this feels more like a tutorial of a specific use-case. The original idea of the readme was to just detail the images capabilities and config options.

I do think this content is of value though, so maybe we should create a docs dir that can be used as a home for tutorials/guides like this. We can then link to this from the main readme page. WDYT? I'm open to any suggestions here if you have something in mind.

@pruivo
Copy link
Member

pruivo commented Nov 18, 2020

Well, the cache creating can be removed because it isn't specific to the image (create a reference to the Infinispan docs?)
The map information is missing "Map the local port 7900 to the port defined in the configuration (7200). On Docker, for example, use -p 7200:7900" and should be in the README.
The rest, I'm OK to be someplace else (or create a link to the existing tutorial).

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.

XSite replication not working
4 participants