add merged npeps to website

This will help us keep track and spread awareness in reguards to in
process work items.

Signed-off-by: astoycos <[email protected]>

Author: astoycos

hack/__pycache__/mkdocs-copy-npeps.cpython-311.pyc

@@ -0,0 +1,24 @@
+# Copyright 2023 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import shutil
+import logging
+from mkdocs import plugins
+
+log = logging.getLogger('mkdocs')
+
+@plugins.event_priority(100)
+def on_pre_build(config, **kwargs):
+    log.info("copying npeps")
+    shutil.copytree("npeps","site-src/npeps", dirs_exist_ok=True)

hack/mkdocs-copy-npeps.py

@@ -3,6 +3,10 @@ repo_url: https://github.com/kubernetes-sigs/network-policy-api
 repo_name: kubernetes-sigs/network-policy-api
 site_dir: site
 docs_dir: site-src
+hooks:
+- hack/mkdocs-copy-npeps.py
+watch:
+- npeps
 theme:
   name: material
   icon:
@@ -48,19 +52,13 @@ nav:
   - Reference:
     - Examples: reference/examples.md
     - API Reference: reference/spec.md
-    - Enhancement Proposals: enhancements.md
-
-
-# (TODO)
-#  - Implementation Guidelines: concepts/guidelines.md
-#  - Versioning: concepts/versioning.md
-#    - Implementations: implementations.md
-#    - FAQ: faq.md
-  # - Guides:
-  #   - Getting started: guides/getting-started.md
-  # - Contributing:
-  #   - Developer guide: contributing/devguide.md
-  #   - Enhancement Tracking and Backlog: contributing/enhancement-requests.md
-  #   - Community: contributing/community.md
-  # - Blog: 
-  #   - Index: blog/index.md
+    - Enhancement Proposals:
+      - Overview: enhancements.md
+      - Template: npeps/npep-95.md
+      - Provisional: 
+        - npeps/npep-126-egress-traffic-control.md
+      - Implementable:
+        - npeps/npep-137-conformance-profiles.md
+        # - Experimental:
+        # - Standard:
+        # - Declined:

mkdocs.yml

@@ -1,11 +1,11 @@
 Click==7.0
 htmlmin==0.1.12
-Jinja2==2.11.1
+Jinja2==3.1.2
 jsmin==3.0.0
 livereload==2.6.1
 Markdown==3.3.4
-MarkupSafe==1.1.1
-mkdocs==1.2.2
+MarkupSafe==2.1.3
+mkdocs==1.5.2
 mkdocs-awesome-pages-plugin==2.7.0
 mkdocs-macros-plugin==0.6.0
 mkdocs-material==7.3.3

requirements.txt

@@ -55,7 +55,8 @@ NPEP process is supposed to be iterative, adding more details with every iterati
 To start NPEP process, create a PR adding `npep-<issue number>.md` file in the
 [npep folder](https://github.com/kubernetes-sigs/network-policy-api/tree/master/npep)
 using the [template NPEP](https://github.com/kubernetes-sigs/network-policy-api/blob/master/npep/npep-95.md) as a
-starting point.
+starting point. Make sure to also add your new NPEP to the website, this can be done within
+the `index.md` file at the root of the repo.
 
 ### 4. Provisional: Agree on the Goals and applicable User-Stories