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.

Sign up for GitHub

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

Jump to bottom

[#20] Create the wiki for the infrastructure template #205

Merged
merged 19 commits into from
Aug 31, 2023
Merged

[#20] Create the wiki for the infrastructure template #205

merged 19 commits into from
Aug 31, 2023

Conversation

longnd
Copy link
Contributor

@longnd longnd commented Jul 18, 2023 •
edited
Loading

What happened 👀

This PR focuses on migrating the existing content to Github Wiki so more dicumentation can be added more easily.

  • Add a Github Action Workflow to publish the documentation to Github Wiki
  • Restructure the existing content (README, Contributing.md) to the Wiki.
    Besides that, this PR also adds a small guideline for the infrastructure diagram under the Contributing section.

Insight 📝

Proof Of Work 📹

Please check the Wiki tab of this repository.
Screenshot 2023-08-30 at 11 26 37

@longnd longnd added the type : feature New feature or request label Jul 18, 2023
@longnd longnd self-assigned this Jul 18, 2023
@longnd longnd changed the title Create the wiki for the infrastructure template [#20] Create the wiki for the infrastructure template Jul 18, 2023
@hoangmirs
Copy link
Collaborator

@longnd Should we separate the PR into 2? One for setting up the WIKI, another for content?

@longnd longnd force-pushed the feature/20-create-project-wiki branch from b6d9ff7 to 152f569 Compare August 30, 2023 00:47
@longnd longnd force-pushed the feature/20-create-project-wiki branch from 093953e to 105e18a Compare August 30, 2023 01:27
@longnd longnd marked this pull request as ready for review August 30, 2023 04:27
@longnd
Copy link
Contributor Author

longnd commented Aug 30, 2023

Should we separate the PR into 2? One for setting up the WIKI, another for content?

yes, that is what this PR delivered. I updated the PR description to state it clearly :)

hoangmirs
hoangmirs reviewed Aug 30, 2023
View reviewed changes
Copy link
Collaborator

@hoangmirs hoangmirs left a comment

Choose a reason for hiding this comment

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

LGTM 💪
Thank you for the nice work 🙏

CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/wiki/_Sidebar.md Outdated Show resolved Hide resolved
.github/wiki/Contributing-guidelines.md Outdated Show resolved Hide resolved
@hoangmirs hoangmirs added this to the 2.0.0 milestone Aug 30, 2023
Nihisil
Nihisil reviewed Aug 31, 2023
View reviewed changes
README.md Show resolved Hide resolved
@longnd longnd force-pushed the feature/20-create-project-wiki branch from 7117776 to 125895f Compare August 31, 2023 08:44
@longnd longnd force-pushed the feature/20-create-project-wiki branch 2 times, most recently from d2af82a to a3591e5 Compare August 31, 2023 08:57
@longnd longnd force-pushed the feature/20-create-project-wiki branch from a3591e5 to 4875f60 Compare August 31, 2023 08:59
@longnd longnd force-pushed the feature/20-create-project-wiki branch from 7dac05b to 1ba916b Compare August 31, 2023 09:02
Nihisil
Nihisil reviewed Aug 31, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
hoangmirs
hoangmirs approved these changes Aug 31, 2023
View reviewed changes
Copy link
Collaborator

@hoangmirs hoangmirs left a comment

Choose a reason for hiding this comment

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

LGTM

.github/wiki/Architecture-overview.md Outdated Show resolved Hide resolved
.github/wiki/Architecture-overview.md Outdated Show resolved Hide resolved
@hoangmirs hoangmirs merged commit 3a08f2b into develop Aug 31, 2023
@hoangmirs hoangmirs deleted the feature/20-create-project-wiki branch August 31, 2023 09:51
@hoangmirs hoangmirs mentioned this pull request Aug 31, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hoangmirs hoangmirs hoangmirs approved these changes

@Nihisil Nihisil Nihisil approved these changes

@andyduong1920 andyduong1920 Awaiting requested review from andyduong1920 andyduong1920 is a code owner

@bterone bterone Awaiting requested review from bterone bterone is a code owner

@byhbt byhbt Awaiting requested review from byhbt byhbt is a code owner

@malparty malparty Awaiting requested review from malparty malparty is a code owner

@nvminhtue nvminhtue Awaiting requested review from nvminhtue nvminhtue is a code owner

@rosle rosle Awaiting requested review from rosle

@liamstevens111 liamstevens111 Awaiting requested review from liamstevens111 liamstevens111 is a code owner

Assignees

@longnd longnd

Labels
type : feature New feature or request
Projects
None yet
Milestone
2.0.0
Development

Successfully merging this pull request may close these issues.

Create the wiki for the infrastructure template
3 participants
@longnd @hoangmirs @Nihisil