search

oopt-goldstone / goldstone-buildimage

Scripts which perform an installable binary image build for Goldstone-NOS
BSD 3-Clause "New" or "Revised" License
4 stars 6 forks source link

Goldstone wiki content #34

Closed HarshaF1 closed 1 year ago

HarshaF1 commented 1 year ago

I have come up with the basic/initial content for goldstone wiki documentation. For now I have created a .md file in docs folder for discussion/review, once we converge on the content I will copy paste this content to wiki. I couldn't think of anyother way to get the wiki reviewed. Please let me know if there is a better way to do this.

Sections Configuration Guide & CLI reference guide are still WIP. Meanwhile I would request you to go through the document and provide inputs on

KazuyaAnazawa commented 1 year ago

@HarshaF1 Thank you so much for your work. I will give comments after I check the contents in detail.

KazuyaAnazawa commented 1 year ago

@HarshaF1 I took a look at the documents, and added several comments. Please take a look. If needed, I can work together.

HarshaF1 commented 1 year ago

Apologies for the delay in addressing the review comments. I have addressed the review comments , could you please take another look. And also please feel free to add more information if required.

ishidawataru commented 1 year ago

@KazuyaAnazawa Can we merge this PR?

KazuyaAnazawa commented 1 year ago

@ishidawataru @HarshaF1 I'm so sorry for the delayed response. I checked the whole sections. The comments from my side are modified, and it looks good to me.

@HarshaF1 It seems the work here is in progress . Do you plan to add more detailed explanation? Or, can we merge this PR?

HarshaF1 commented 1 year ago

@KazuyaAnazawa we can merge this PR. This will be a place holder and good start for others to update the wiki content as required. Once this PR is merged I will copy the content to the wiki page here

KazuyaAnazawa commented 1 year ago

@HarshaF1 Thank you for telling. I see, sorry for my misunderstanding.

@ishidawataru We can merge the PR now. If it's ok, could you merge?

HarshaF1 commented 1 year ago

@ishidawataru yes sure I will rename the file. Shall I keep this README.md in docs folder or replace the README.md file from the main folder ? Or I will copy all the content from this file to wiki page and we could abandon this PR. Please let me know what do think would be better.

ishidawataru commented 1 year ago

Let's keep the current README.md as is and keep the new file in docs directory.

ishidawataru commented 1 year ago

@HarshaF1 Sorry for the delay. Merged the PR.