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

updated readme with nikola architecture #1600

Merged
merged 1 commit into from Jan 25, 2015
Merged

Conversation

@khatribharat
Copy link

khatribharat commented Jan 25, 2015

Updated README.rst with a section on Nikola Architecture

@ralsina
Copy link
Member

ralsina commented Jan 25, 2015

Hey that's pretty nifty!

What did you use to edit it? We may have to change it in the future and it would be better to have the same tool.

Is there a way to layout the diagram so it's not so wide?

@khatribharat
Copy link
Author

khatribharat commented Jan 25, 2015

I used https://www.draw.io to create it. nikola-architecture-draw-io.xml can be imported and edited using draw.io for any changes in future.

@Kwpolska
Copy link
Member

Kwpolska commented Jan 25, 2015

nikola auto ≠ doit auto. Just remove that tile.

The XML file contains your user agent, please clean it up. It would also be
better if you used SVG.
We'll have to host it on the website and link there so that pypi shows it
correctly; we should also put it in the internals documentation.

Chris Warrick https://chriswarrick.com/
Sent from my Galaxy S3.
On Jan 25, 2015 5:29 PM, "Bharat Khatri" notifications@github.com wrote:

I used https://www.draw.io to create it. nikola-architecture-draw-io.xml
can be imported and edited using draw.io for any changes in future.


Reply to this email directly or view it on GitHub
#1600 (comment).

@felixfontein
Copy link
Contributor

felixfontein commented Jan 25, 2015

What kind of file format is this? (I know it's XML, but that is mainly a very thin wrapper around something which looks base64 encoded or so.) Can it be used with anything else but draw.io?

@schettino72
Copy link
Member

schettino72 commented Jan 25, 2015

nice...

  • nitpick: please spell doit using only lower-case letters
  • commands are also implementations of doit commands

@Kwpolska exactly because Nikola auto is different from doit auto it should be in diagram. It shows the commands that are overwritten by Nikola.

@khatribharat
Copy link
Author

khatribharat commented Jan 25, 2015

Does this look good?
@felixfontein I'm not sure if the format could be imported into other drawing tools or not.
@ralsina I've not been able to change the layout, it certainly looks wide right now.

@khatribharat
Copy link
Author

khatribharat commented Jan 25, 2015

@Kwpolska Added SVG and JPG (since GitHub doesn't render SVG in the readme file). Also cleaned up nikola-architecture-draw-io.xml

@Kwpolska
Copy link
Member

Kwpolska commented Jan 25, 2015

@khatribharat

  1. Remove the JPG, as JPG is the worst possible format for presenting images (as opposed to pictures).
  2. Add a PNG.
  3. Put all the files (svg, xml, png) in a different directory, like docs/architecture.
  4. Then squash the commits so the repo is cleaner.
@khatribharat khatribharat force-pushed the khatribharat:master branch from 833836d to bee2a6e Jan 25, 2015
@khatribharat
Copy link
Author

khatribharat commented Jan 25, 2015

@Kwpolska Done as suggested.

@Kwpolska Kwpolska added this to the v7.3.1 milestone Jan 25, 2015
@Kwpolska
Copy link
Member

Kwpolska commented Jan 25, 2015

Perfect. @ralsina, pull the trigger if it’s okay.

@khatribharat, one more thing (that can be done at any time, regardless of merge status): add bharat.k@directi.com to your GitHub emails.

@khatribharat
Copy link
Author

khatribharat commented Jan 25, 2015

@Kwpolska That's my office email, can't add that here. ;) Only some emails from my personal email address contain this as the alternate email in the signature.

ralsina added a commit that referenced this pull request Jan 25, 2015
updated readme with nikola architecture
@ralsina ralsina merged commit b061850 into getnikola:master Jan 25, 2015
2 checks passed
2 checks passed
continuous-integration/appveyor AppVeyor build succeeded
Details
continuous-integration/travis-ci The Travis CI build passed
Details
@Kwpolska
Copy link
Member

Kwpolska commented Jan 26, 2015

@khatribharat (And now it’s publicly available for anyone who clones our repo and cares to look at this commit.)

@khatribharat
Copy link
Author

khatribharat commented Jan 26, 2015

Thanks for the merge! My first contribution to a big open source project. 😃

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

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.