Skip to content

Commit a54c799

Browse files
chmodshubhamchmodshubham
authored
Merge pull request #41 from chmodshubham/main
Rename Ngkore to NgKore Foundation
2 parents 65443c9 + e98d832 commit a54c799

19 files changed

Lines changed: 145 additions & 146 deletions

‎.sphinx/_static/bottom-logo.js‎

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,38 @@
1-
document.addEventListener('DOMContentLoaded', function () {
1+
document.addEventListener("DOMContentLoaded", function () {
22
try {
33
// Avoid duplicates on hot reload
4-
if (document.querySelector('.bottom-logo')) return;
4+
if (document.querySelector(".bottom-logo")) return;
55

6-
const container = document.createElement('div');
7-
container.className = 'bottom-logo';
6+
const container = document.createElement("div");
7+
container.className = "bottom-logo";
88

9-
const link = document.createElement('a');
10-
link.className = 'bottom-logo-link';
11-
link.href = 'https://ngkore.org';
12-
link.title = 'NgKore';
13-
link.target = '_blank';
14-
link.rel = 'noopener noreferrer';
15-
link.setAttribute('aria-label', 'NgKore website');
9+
const link = document.createElement("a");
10+
link.className = "bottom-logo-link";
11+
link.href = "https://ngkorefoundation.org";
12+
link.title = "NgKore Foundation";
13+
link.target = "_blank";
14+
link.rel = "noopener noreferrer";
15+
link.setAttribute("aria-label", "NgKore website");
1616

17-
const img = document.createElement('img');
18-
img.className = 'bottom-logo-image';
19-
img.alt = 'NgKore';
20-
img.loading = 'lazy';
21-
img.decoding = 'async';
17+
const img = document.createElement("img");
18+
img.className = "bottom-logo-image";
19+
img.alt = "NgKore Foundation";
20+
img.loading = "lazy";
21+
img.decoding = "async";
2222
// Prefer optimized asset in .sphinx/_static if available; fallback to repo image path
23-
const urlRoot = document.body.getAttribute('data-url_root') || '/';
23+
const urlRoot = document.body.getAttribute("data-url_root") || "/";
2424
// Prefer the static bundled logo to avoid path issues
25-
img.src = urlRoot + '_static/ngkore-logo.png';
25+
img.src = urlRoot + "_static/ngkore-logo.png";
2626
// Fallback to absolute path if urlRoot missing
2727
img.onerror = function () {
2828
img.onerror = null;
29-
img.src = '/_static/ngkore-logo.png';
29+
img.src = "/_static/ngkore-logo.png";
3030
};
3131

3232
link.appendChild(img);
3333
container.appendChild(link);
3434
document.body.appendChild(container);
3535
} catch (e) {
36-
console.warn('Failed to attach bottom logo:', e);
36+
console.warn("Failed to attach bottom logo:", e);
3737
}
3838
});
39-
40-

‎.sphinx/_static/ngkore-logo.png‎

-49.4 KB
Loading

‎.sphinx/_templates/page.html‎

Lines changed: 72 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,88 +1,84 @@
1-
{% extends "!page.html" %}
2-
3-
{% block extrahead %}
4-
{{ super() }}
1+
{% extends "!page.html" %} {% block extrahead %} {{ super() }}
52
<!-- Enhanced SEO meta tags -->
6-
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="theme-color" content="#2196F3">
3+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
4+
<meta name="theme-color" content="#2196F3" />
85

96
<!-- Topic-specific structured data -->
107
<script type="application/ld+json">
11-
{
12-
"@context": "https://schema.org",
13-
"@type": "TechnicalArticle",
14-
"publisher": {
15-
"@type": "Organization",
16-
"name": "NgKore",
17-
"url": "https://docs.ngkore.org",
18-
"logo": {
19-
"@type": "ImageObject",
20-
"url": "https://docs.ngkore.org/_static/ngkore-logo.svg"
21-
}
22-
},
23-
"mainEntityOfPage": {
24-
"@type": "WebPage",
25-
"@id": "{{ pageurl|e }}"
26-
},
27-
"headline": "{{ title|e }}",
28-
"description": "{% if meta and meta.description %}{{ meta.description|e }}{% else %}{{ title|e }} - NgKore Documentation covering 5G Core Networks, Post-Quantum Cryptography, eBPF Technology, O-RAN, Network Security, and more.{% endif %}",
29-
"keywords": "{% if meta and meta.keywords %}{{ meta.keywords|e }}{% else %}5G core, post-quantum cryptography, eBPF, O-RAN, network security, NgKore{% endif %}",
30-
"about": [
31-
{
32-
"@type": "Thing",
33-
"name": "5G Core Networks",
34-
"description": "Next-generation mobile network architecture"
35-
},
36-
{
37-
"@type": "Thing",
38-
"name": "Post-Quantum Cryptography",
39-
"description": "Quantum-resistant encryption algorithms"
8+
{
9+
"@context": "https://schema.org",
10+
"@type": "TechnicalArticle",
11+
"publisher": {
12+
"@type": "Organization",
13+
"name": "NgKore Foundation",
14+
"url": "https://docs.ngkorefoundation.org",
15+
"logo": {
16+
"@type": "ImageObject",
17+
"url": "https://docs.ngkorefoundation.org/_static/ngkore-logo.svg"
18+
}
4019
},
41-
{
42-
"@type": "Thing",
43-
"name": "eBPF Technology",
44-
"description": "Extended Berkeley Packet Filter for kernel programming"
20+
"mainEntityOfPage": {
21+
"@type": "WebPage",
22+
"@id": "{{ pageurl|e }}"
4523
},
46-
{
47-
"@type": "Thing",
48-
"name": "O-RAN",
49-
"description": "Open Radio Access Network interoperability"
50-
}
51-
],
52-
"datePublished": "{{ last_updated|e if last_updated else '2023-01-01' }}",
53-
"dateModified": "{{ last_updated|e if last_updated else '2023-01-01' }}"
54-
}
24+
"headline": "{{ title|e }}",
25+
"description": "{% if meta and meta.description %}{{ meta.description|e }}{% else %}{{ title|e }} - NgKore Documentation covering 5G Core Networks, Post-Quantum Cryptography, eBPF Technology, O-RAN, Network Security, and more.{% endif %}",
26+
"keywords": "{% if meta and meta.keywords %}{{ meta.keywords|e }}{% else %}5G core, post-quantum cryptography, eBPF, O-RAN, network security, NgKore{% endif %}",
27+
"about": [
28+
{
29+
"@type": "Thing",
30+
"name": "5G Core Networks",
31+
"description": "Next-generation mobile network architecture"
32+
},
33+
{
34+
"@type": "Thing",
35+
"name": "Post-Quantum Cryptography",
36+
"description": "Quantum-resistant encryption algorithms"
37+
},
38+
{
39+
"@type": "Thing",
40+
"name": "eBPF Technology",
41+
"description": "Extended Berkeley Packet Filter for kernel programming"
42+
},
43+
{
44+
"@type": "Thing",
45+
"name": "O-RAN",
46+
"description": "Open Radio Access Network interoperability"
47+
}
48+
],
49+
"datePublished": "{{ last_updated|e if last_updated else '2023-01-01' }}",
50+
"dateModified": "{{ last_updated|e if last_updated else '2023-01-01' }}"
51+
}
5552
</script>
5653

5754
<!-- Topic breadcrumbs for better SEO -->
5855
{% if parents %}
5956
<script type="application/ld+json">
60-
{
61-
"@context": "https://schema.org",
62-
"@type": "BreadcrumbList",
63-
"itemListElement": [
64-
{
65-
"@type": "ListItem",
66-
"position": 1,
67-
"name": "NgKore Docs",
68-
"item": "https://docs.ngkore.org/"
69-
}
70-
{% for parent in parents -%}
71-
,{
72-
"@type": "ListItem",
73-
"position": {{ loop.index + 1 }},
74-
"name": "{{ parent.title|e }}",
75-
"item": "{{ parent.link|e }}"
76-
}
77-
{%- endfor %}
78-
,{
79-
"@type": "ListItem",
80-
"position": {{ parents|length + 2 }},
81-
"name": "{{ title|e }}",
82-
"item": "{{ pageurl|e }}"
83-
}
84-
]
85-
}
57+
{
58+
"@context": "https://schema.org",
59+
"@type": "BreadcrumbList",
60+
"itemListElement": [
61+
{
62+
"@type": "ListItem",
63+
"position": 1,
64+
"name": "NgKore Docs",
65+
"item": "https://docs.ngkorefoundation.org/"
66+
}
67+
{% for parent in parents -%}
68+
,{
69+
"@type": "ListItem",
70+
"position": {{ loop.index + 1 }},
71+
"name": "{{ parent.title|e }}",
72+
"item": "{{ parent.link|e }}"
73+
}
74+
{%- endfor %}
75+
,{
76+
"@type": "ListItem",
77+
"position": {{ parents|length + 2 }},
78+
"name": "{{ title|e }}",
79+
"item": "{{ pageurl|e }}"
80+
}
81+
]
82+
}
8683
</script>
87-
{% endif %}
88-
{% endblock %}
84+
{% endif %} {% endblock %}

‎5g-core/5gc-operator.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
chart from the repository during the API creation. The Helm chart is
1616
then stored locally in the Operator project.
1717
3. **Building the Docker Image** - Once the API and Controller are set
18-
up, we build the ngKore Operator Docker image and then pushed to the
18+
up, we build the 5G Operator Docker image and then pushed to the
1919
Dockerhub registry so it can be accessed and pulled into a
2020
Kubernetes cluster.
2121
4. **Applying the Operator\'s Deployment Manifest** - The Operator is
@@ -24,11 +24,11 @@
2424
kubectl. The Operator is now running in the cluster.
2525
5. **Creating Instances of the Custom Resource** - We can now start
2626
interacting with the Operator by creating instances of the
27-
**ngkore** custom resource. These instances are defined in YAML and
27+
**5G** custom resource. These instances are defined in YAML and
2828
are applied to the cluster using kubectl. This YAML
2929
defines the desired state of our application.
3030
6. **Reconciliation Loop** - The Operator's controller constantly
31-
watches the ngkore custom resource for changes. If it detects a
31+
watches the 5G custom resource for changes. If it detects a
3232
change, it performs the necessary actions to make the cluster
3333
reflect those changes. This is called the reconciliation loop.
3434
7. **Modifying the Custom Resource** - The 'spec' field in the CR

‎LICENSE‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -92,33 +92,33 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9292
meet the following conditions:
9393

9494
(a) You must give any other recipients of the Work or
95-
Derivative Works a copy of this License; and
95+
Derivative Works a copy of this License; and
9696

9797
(b) You must cause any modified files to carry prominent notices
98-
stating that You changed the files; and
98+
stating that You changed the files; and
9999

100100
(c) You must retain, in the Source form of any Derivative Works
101-
that You distribute, all copyright, trademark, patent,
102-
attribution and other notices from the Source form of the Work,
103-
excluding those notices that do not pertain to any part of
104-
the Derivative Works; and
101+
that You distribute, all copyright, trademark, patent,
102+
attribution and other notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105105

106106
(d) If the Work includes a "NOTICE" file as part of its
107-
distribution, then any Derivative Works that You distribute must
108-
include a readable copy of the attribution notices contained
109-
within such NOTICE file, excluding those notices that do not
110-
pertain to any part of the Derivative Works, in at least one
111-
of the following places: within a NOTICE file distributed
112-
as part of the Derivative Works; within the Source form or
113-
documentation, if provided along with the Derivative Works; or,
114-
within a display generated by the Derivative Works, if and
115-
wherever such third-party notices normally appear. The contents
116-
of the NOTICE file are for informational purposes only and
117-
do not modify the License. You may add Your own attribution
118-
notices within Derivative Works that You distribute, alongside
119-
or as an addendum to the NOTICE text from the Work, provided
120-
that such additional attribution notices cannot be construed
121-
as modifying the License.
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122122

123123
You may add Your own copyright notice or other proprietary rights
124124
notices to any modifications You make to the Work. You may provide
@@ -181,13 +181,13 @@ APPENDIX: How to apply the Apache License to your work.
181181
To apply the Apache License to your work, attach the following
182182
boilerplate notice, with the fields enclosed by brackets "[]"
183183
replaced with your own identifying information. (Don't include
184-
the brackets!) The text should be enclosed in the appropriate
184+
the brackets!) The text should be enclosed in the appropriate
185185
comment syntax for the file format. We also recommend that a
186186
file or class name and description of purpose be included on the
187187
same "page" as the copyright notice for easier identification
188188
within third-party archives.
189189

190-
Copyright 2023 NgKore Community
190+
Copyright 2023-2025 NgKore Foundation
191191

192192
Licensed under the Apache License, Version 2.0 (the "License");
193193
you may not use this file except in compliance with the License.
@@ -199,4 +199,4 @@ Unless required by applicable law or agreed to in writing, software
199199
distributed under the License is distributed on an "AS IS" BASIS,
200200
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201201
See the License for the specific language governing permissions and
202-
limitations under the License.
202+
limitations under the License.

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NgKore Documentation
22

3-
NgKore (ngkore.org) is an open-source community driving innovation across Post-Quantum Cryptography (PQC), 5G Advanced, 6G, O-RAN, NTN, AI/ML, Blockchain, Quantum technologies, and Cloud-Native Architectures.
3+
NgKore Foundation (ngkorefoundation.org) is an open-source community driving innovation across Post-Quantum Cryptography (PQC), 5G Advanced, 6G, O-RAN, NTN, AI/ML, Blockchain, Quantum technologies, and Cloud-Native Architectures.
44

55
## Contributing
66

@@ -9,10 +9,10 @@ We welcome contributions from the community! See our [How to Contribute](./how-t
99
## Need Help?
1010

1111
- **GitHub Issues**: [Create an issue](https://github.com/ngkore/docs/issues/new)
12-
- **Email**: contact@ngkore.org
12+
- **Email**: contact@ngkorefoundation.org
1313

1414
## License
1515

1616
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://github.com/ngkore/docs/blob/main/LICENSE) file for details.
1717

18-
Copyright © 2023 NgKore Community. All rights reserved.
18+
Copyright © 2023-2025 NgKore Foundation. All rights reserved.

0 commit comments

Comments
 (0)