Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Update README file to reflect the modular architecture changes - Closes #3075 #3129

Merged
merged 17 commits into from
Mar 25, 2019

Conversation

Tschakki
Copy link
Contributor

@Tschakki Tschakki commented Mar 20, 2019

What was the problem?

Readme files were missing or missing content.

How did I fix it?

Created Readme files and added missing content.

Documentation is focussing mainly on the corresponding LIP https://github.com/LiskHQ/lips/blob/master/proposals/lip-0005.md, as implementation is still in progress.

How to test it?

Check README.md in framework/src/modules, framework/src/components, framework/src/controller

Review checklist

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved

### Logger

Logger is responsible for all application-level logging activity and logs everything in JSON format.
Copy link
Collaborator

Choose a reason for hiding this comment

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

does it log in JSON format now?

Copy link
Contributor

Choose a reason for hiding this comment

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

As of now no.

Copy link
Contributor

Choose a reason for hiding this comment

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

We didn't include it in 1.6.0. We should do it in 2.0.

That's something we would have to amend in the LIP if 1.6.0 is about to close the objective.

Copy link
Contributor

Choose a reason for hiding this comment

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

I deleted the false part for now.

framework/src/components/README.md Outdated Show resolved Hide resolved
framework/src/modules/README.md Outdated Show resolved Hide resolved
framework/src/modules/README.md Outdated Show resolved Hide resolved
framework/src/modules/README.md Outdated Show resolved Hide resolved
* Default configuration file
* Network specific configuration file
* Custom configuration file (if specified by user)
* Custom configuration file (if specified by the user)
Copy link
Contributor

Choose a reason for hiding this comment

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

This structure will change in 1.6 and development branch is dedicated for it, do we need to merge this changes and then update this section again in other PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

Mona here updated the typos only, which is fine.


### Logger

Logger is responsible for all application-level logging activity and logs everything in JSON format.
Copy link
Contributor

Choose a reason for hiding this comment

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

As of now no.

nazarhussain
nazarhussain previously approved these changes Mar 25, 2019
Correct the components descriptions
shuse2 and others added 2 commits March 25, 2019 19:36
Fix the description typos

Co-Authored-By: MaciejBaj <macie.baj@gmail.com>
Change the system component description
framework/src/modules/README.md Outdated Show resolved Hide resolved
@MaciejBaj MaciejBaj changed the title Create Readme files - Closes #3075 Update README file to reflect the modular architecture changes - Closes #3075 Mar 25, 2019
@MaciejBaj MaciejBaj requested a review from lsilvs March 25, 2019 19:57
@MaciejBaj MaciejBaj merged commit ff202e5 into development Mar 25, 2019
@MaciejBaj MaciejBaj deleted the 3075-create-readme-files branch March 25, 2019 19:58
@Tschakki Tschakki mentioned this pull request Apr 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update README file to reflect the modular architecture changes
5 participants