Skip to content

Documentation major update#128

Merged
xadahiya merged 5 commits intoHTTP-APIs:developfrom
gustavodemorais:documentation-update
Aug 22, 2019
Merged

Documentation major update#128
xadahiya merged 5 commits intoHTTP-APIs:developfrom
gustavodemorais:documentation-update

Conversation

@gustavodemorais
Copy link
Copy Markdown
Contributor

I've done some considerable changes to reorder and organization trying to make the readme more straightforward. Please take a look and let me know if you have a suggestion.

  • Improved layout and tried to create a standard way to install for both the current interfaces we have: the CLI and the Package.
  • Pushed specific documentation about the Redis interactions to the Redis folder.
  • Update package description, created a summary and tried to fix some writing issues(I think there might be some typos left)

@xadahiya xadahiya merged commit a3031b4 into HTTP-APIs:develop Aug 22, 2019
xadahiya added a commit that referenced this pull request Aug 22, 2019
* Adding python-socketio to requirements

* Sending correct parameter to GraphOperations

* Adding Socket to Agent and Defining sync Rules

* Adjusting Docstrings

* Adjusting tests to Mock Socket Connect

* Typo and Coding Standards

* Removing unused import and leftover comment

* Restart Agent when it's too outdated

* Adding Docstrings

* Better naming and PEP8

* Receiving updates through socket packages

* Connecting to hydrus

* Updating Test Doc with changes from Hydra Core

* Changing socket URL to use hydrus URL by default

* Modifying empty modification table check to status code

* Migrating from HTTP Table-Diff to Socket packages

* Changing connection/reconnecting method using socket data

* Adjusting Redis Graph Docker Hub Image

* Dealing with warning use cases

* Adjusting Agent's gitignore

* Adjusting Agent's Graph Initialization routine 

That way the function can also be used to provide the ApiDoc to the GUI

* Formatting embedded resources link and adjusting tests

* Documentation major update (#128)

* Adding small summary

* Updating installation instructions

* Updating description

* Changing order, writing, layout and Porting details to internal README

* Adjusting  redis_setup comments writing
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.

2 participants