Skip to content
This repository has been archived by the owner on Dec 1, 2021. It is now read-only.

Remove unused DLK readme files #878

Merged
merged 6 commits into from
Mar 4, 2020
Merged

Remove unused DLK readme files #878

merged 6 commits into from
Mar 4, 2020

Conversation

Joeper214
Copy link
Contributor

@Joeper214 Joeper214 commented Feb 26, 2020 •
edited
Loading

What this patch does to fix the issue.

These Docs is not used and maintained anymore so It's better to get rid of them.

Link to any relevant issues or pull requests.

n/a

@Joeper214 Joeper214 self-assigned this Feb 26, 2020
@blueoil-butler blueoil-butler bot added the CI: auto-run Run CI automatically label Feb 26, 2020
@bo-code-review-bot
Copy link

This PR needs Approvals as follows.

  • Ownership Approval for / from iizukak, tkng, ruimashita

Please choose reviewers and requet reviews!

Click to see how to approve each reviews

You can approve this PR by triggered comments as follows.

  • Approve all reviews requested to you (readability and ownership) and LGTM review
    Approval, LGTM

  • Approve all ownership reviews
    Ownership Approval or OA

  • Approve all readability reviews
    Readability Approval or RA

  • Approve specified review targets

    • Example of Ownership Reviewer of /: Ownership Approval for / or OA for /
    • Example of Readability Reviewer of Python: Readability Approval for Python or RA for Python

  • Approve LGTM review
    LGTM

See all trigger comments

Please replace [Target] to review target

  • Ownership Approval
    • Ownership Approval for [Target]
    • OA for [Target]
    • Ownership Approval
    • OA
    • Approval
  • Readability Approval
    • Readability Approval for [Target]
    • RA for [Target]
    • [Target] Readability Approval
    • [Target] RA
    • Readability Approval
    • RA
    • Approval
  • LGTM
    • LGTM
    • lgtm

@Joeper214 Joeper214 requested review from iizukak and kchygoe February 26, 2020 09:45
@Joeper214 Joeper214 changed the title Remove unused DLK readme files Remove deprecated DLK readme files Feb 27, 2020
@Joeper214 Joeper214 changed the title Remove deprecated DLK readme files Remove unused DLK readme files Feb 27, 2020
@iizukak
Copy link
Member

iizukak commented Feb 27, 2020

@Joeper214
Thanks you for the refactor.
Theses files are mostly deprecated, but some of the information is useful, for example dlk/README.md contains description about generate_project.py.
Before remove, we should consider which description is necessary...

@Joeper214
Copy link
Contributor Author

Joeper214 commented Feb 28, 2020 •
edited
Loading

@iizukak How about this?

plocy.md (can be deleted)
packages.md (can be deleted)
setup_board.md (needs to be merged with blueoil)

@iizukak
Copy link
Member

iizukak commented Feb 28, 2020

@Joeper214 Agreed.

@kchygoe
Copy link
Member

kchygoe commented Mar 2, 2020

Can you fix the index.rst along with your change?

@Joeper214
Copy link
Contributor Author

@iizukak @kchygoe I updated the PR again based on the previous comments. Please check PR again.

@iizukak
Copy link
Member

iizukak commented Mar 4, 2020 •
edited
Loading

@Joeper214
In README.md, There is some description about generate_project.py. It's little bit useful.
In setup_board.md, There is some description about DE10-Nano boards.
I think these description should be move to other documentation.
You have plan to create new document file after this PR merged?

@Joeper214
Copy link
Contributor Author

@iizukak I added docs/dlk/overview.md on index.rst and trimmed the necessary information. Please check again. 🙇

iizukak
iizukak approved these changes Mar 4, 2020
View reviewed changes
Copy link
Member

@iizukak iizukak left a comment

Choose a reason for hiding this comment

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

OA

@Joeper214 Joeper214 added the CI: test-dlk Run dlk test once label Mar 4, 2020
@blueoil-butler blueoil-butler bot removed the CI: test-dlk Run dlk test once label Mar 4, 2020
kchygoe
kchygoe approved these changes Mar 4, 2020
View reviewed changes
Copy link
Member

@kchygoe kchygoe left a comment

Choose a reason for hiding this comment

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

LGTM, let's start to modify from now on!

@Joeper214
Copy link
Contributor Author

/ready

@bo-mergebot
Copy link
Contributor

bo-mergebot bot commented Mar 4, 2020

⏳Merge job is queued...

@bo-mergebot bo-mergebot bot merged commit fcfd234 into blue-oil:master Mar 4, 2020
@Joeper214 Joeper214 deleted the update_docs branch March 5, 2020 02:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@iizukak iizukak iizukak approved these changes

@kchygoe kchygoe kchygoe approved these changes

Assignees

@Joeper214 Joeper214

Labels
CI: auto-run Run CI automatically documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Joeper214 @iizukak @kchygoe