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

Add a "Developer Guide" section to the network-policy-api website #165

Open
astoycos opened this issue Oct 27, 2023 · 10 comments · May be fixed by #242
Open

Add a "Developer Guide" section to the network-policy-api website #165

astoycos opened this issue Oct 27, 2023 · 10 comments · May be fixed by #242
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.

Comments

@astoycos
Copy link
Member

Describe the issue:
This issue will track the work for adding a "Developer Guide" section to our website. The Gateway API's developer guide may be of some help here :) see -> https://gateway-api.sigs.k8s.io/contributing/devguide/

@astoycos astoycos added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Oct 27, 2023
@prashantrewar
Copy link

hey @astoycos, I would like to work on this issue, is this issue still up for grabs?

@astoycos
Copy link
Member Author

astoycos commented Jan 9, 2024

Hiya @prashantrewar Yes that would be great 🎆

/assign @prashantrewar

@prashantrewar
Copy link

@astoycos Could you please guide me on this

what I understand is that we need to add a new section of the Developer guide in the network policy API website

@prashantrewar
Copy link

Do you want me to add this developer guide documentation to the network policy API website?

@astoycos
Copy link
Member Author

astoycos commented Jan 9, 2024

I'll work on adding a more descriptive idea of what I'm talking about here over the day today, at a high level it may contain a pointer back to the core k8s dev docs but should be more similar to https://gateway-api.sigs.k8s.io/contributing/devguide/

i.e the process of developing specifically our project, i.e what our various make targets do, how to run conformance etc

@jgao1025
Copy link

jgao1025 commented Jul 7, 2024

Hi @astoycos,

I've noticed that the issue hasn't been worked on for a while. As someone new to this area, I'd like to take a stab at it if you're still looking for an implementation.

@prashantrewar Shall I check that if you plan to continue work on this?

@prashantrewar prashantrewar removed their assignment Jul 8, 2024
@prashantrewar
Copy link

@jgao1025, you can try for it.

/assign @jgao1025

@jgao1025
Copy link

@jgao1025, you can try for it.

/assign @jgao1025

@prashantrewar Thanks for replying. I am really new and very excited to pick my fist ticket on a CNCF project. I will try my best to see how I can go. :)

@jgao1025
Copy link

jgao1025 commented Jul 14, 2024

I spent some time this week on this job, and as this is my first commit, I suppose I would spend some time investing the setup, enviornment, etc.

Here is my plan:

  1. create a single node k8s culster on a virtual dev node according to this - this is done

  2. following this doc and test if one node k8s cluster can install the prod network product. - this is done

  3. from the make file, try to find how to build a new version. - done
    I have worked out this one but it needs a bit steps so I just record here.
    a). read Makefile file, and find out that build the doc website is Line 80, and deploy website locally is line 85.
    b). it needs mkdocs which is a python program, so it is better to install venv on the local machine.
    c). install the following python lib: pip install mkdocs mkdocs-material-extensions mike mkdocs-material
    d). Also Golang is needed.
    e). The website should be building fine now.
    d). now run make local-docs so that the website will be running locally and ready to be changed.

  4. get familiar with pull request process. - done

  5. build a new version and change a bit, then try to see if it can be installable to the one node cluster. - done

  6. record all the steps above and write a new web page. - done

@jgao1025
Copy link

Yep, it's done. :))) I submitted a PR recently.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants