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

Adding Makerdiary and Feitian installation guide #347

Closed
wants to merge 1 commit into from

Conversation

epita-cs2
Copy link

we found that our github Installation guide for Makerdiary and Feitian they are good than the one mentioned in Hyperlinks.
If it is possible to put our links in addition, kindly find them below:

https://github.com/epita-cs2/Implementation-OpenSK-on-Makerdiary-nrf52840-mdk-usb-dongle

and

https://github.com/epita-cs2/Implementation-OpenSK-on-Feitian-nrf52840-usb-dongle

Fixes #<issue_number_goes_here>

It's a good idea to open an issue first for discussion.

  • Tests pass
  • Appropriate changes to README are included in PR

we found that our github Installation guide for Makerdiary and Feitian they are good than the one mentioned in Hyperlinks. 
If it is possible to put our links in addition, kindly find them below: 

https://github.com/epita-cs2/Implementation-OpenSK-on-Makerdiary-nrf52840-mdk-usb-dongle

and 

https://github.com/epita-cs2/Implementation-OpenSK-on-Feitian-nrf52840-usb-dongle
@google-cla
Copy link

google-cla bot commented Jul 22, 2021

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

@kaczmarczyck
Copy link
Collaborator

Thanks for helping with our documentation. I think it's nicer for reading if they don't need the extra indirection of a link at the end of our install documentation. Can we distil the added value of your documentation and integrate it into our repository? That way, readers have all they need in one place.
May I ask to propose changes with missing content directly into our README.md or docs/install.md?

@epita-cs2
Copy link
Author

yes sure, What I meant by this is to add in addition or to put our link as hyperlink for Makerdiary and Feitian in the Installation guide.

For these two hyperlinks:
Makerdiary nRF52840-MDK USB dongle. Instead of https://wiki.makerdiary.com/nrf52840-mdk/ to be: https://github.com/epita-cs2/Implementation-OpenSK-on-Makerdiary-nrf52840-mdk-usb-dongle
Feitian OpenSK dongle. Instead of https://feitiantech.github.io/OpenSK_USB/ to be: https://github.com/epita-cs2/Implementation-OpenSK-on-Feitian-nrf52840-usb-dongle

if not to replace them at least to be a secondary hyperlink.

This will help Makerdiary and Feitian users to have their products because it is easy and straight forward guide line.

Thank you !

@kaczmarczyck
Copy link
Collaborator

I'm commenting here on both this PR and #350. I'd still prefer that the documentation does not link to more sources outside of this repository, since it's impossible for us to maintain. So 2 choices:

  1. Integrate your proposed changes into the existing documentation. That means working with Makerdiary and Feitian to fix their docs.
  2. Integrate your documentation with our own docs. So this PR contains not just the links, but the Markdown itself that a user should read. We can discuss different forms, like having an instructions file per board in docs/ or integrating it into one of the existing manuals, like docs/install.md.

Would that work for you?

@kaczmarczyck kaczmarczyck self-assigned this Jul 27, 2021
@kaczmarczyck kaczmarczyck added the documentation Improvements or additions to documentation label Jul 27, 2021
@geofli
Copy link
Contributor

geofli commented Jul 28, 2021

@epita-cs2 , I'm not sure whether you have tested our Feitian USB dongle, but some command is not available to this dongle, for example,
./deploy.py --board=nrf52840_mdk_dfu --opensk --panic-console
./deploy.py --board=nrf52840_dongle_dfu --opensk --programmer=nordicdfu --clear-storage

@epita-cs2
Copy link
Author

I'm commenting here on both this PR and #350. I'd still prefer that the documentation does not link to more sources outside of this repository, since it's impossible for us to maintain. So 2 choices:

1. Integrate your proposed changes into the existing documentation. That means working with Makerdiary and Feitian to fix their docs.

2. Integrate your documentation with our own docs. So this PR contains not just the links, but the Markdown itself that a user should read. We can discuss different forms, like having an instructions file per board in `docs/` or integrating it into one of the existing manuals, like `docs/install.md`.

Would that work for you?

Good Morning,
The second option, seems good by adding a new document inside docs folder for Makerdiary.

Thank you.

@epita-cs2
Copy link
Author

@epita-cs2 , I'm not sure whether you have tested our Feitian USB dongle, but some command is not available to this dongle, for example,
./deploy.py --board=nrf52840_mdk_dfu --opensk --panic-console
./deploy.py --board=nrf52840_dongle_dfu --opensk --programmer=nordicdfu --clear-storage

did not try them. I am facing problems with Feitian dongle that we have. We will try to use this one, otherwise we will have to purchase a new one and try these commands.
Thank you for your cooperation.

@geofli
Copy link
Contributor

geofli commented Jul 29, 2021

did not try them. I am facing problems with Feitian dongle that we have. We will try to use this one, otherwise we will have to purchase a new one and try these commands.

What problem have you met? Is it similar to #348 ?

@epita-cs2
Copy link
Author

did not try them. I am facing problems with Feitian dongle that we have. We will try to use this one, otherwise we will have to purchase a new one and try these commands.

What problem have you met? Is it similar to #348 ?

No my authenticator does not enter the DFU mode and it seems that the button it is not working anymore.

@superskybird
Copy link
Contributor

Would you please check according to https://feitiantech.github.io/OpenSK_USB/hardware/#1-led-breathing and https://feitiantech.github.io/OpenSK_USB/hardware/#2-linux ? If there is the hardware problem indeed, we can ship you a new one.

@kaczmarczyck
Copy link
Collaborator

I'm closing this PR due to inactivitity since more than a month. This is not a rejection, feel free to create new issues and PRs as you see fit! With this PR in particular, if you have time to integrate your documentation changes behind the links, we appreciate that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: no documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lack of information in the Makerdiary guide, it is not straight forward
4 participants