Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 20 additions & 22 deletions .sphinx/_static/bottom-logo.js
Original file line number Diff line number Diff line change
@@ -1,40 +1,38 @@
document.addEventListener('DOMContentLoaded', function () {
document.addEventListener("DOMContentLoaded", function () {
try {
// Avoid duplicates on hot reload
if (document.querySelector('.bottom-logo')) return;
if (document.querySelector(".bottom-logo")) return;

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

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

const img = document.createElement('img');
img.className = 'bottom-logo-image';
img.alt = 'NgKore';
img.loading = 'lazy';
img.decoding = 'async';
const img = document.createElement("img");
img.className = "bottom-logo-image";
img.alt = "NgKore Foundation";
img.loading = "lazy";
img.decoding = "async";
// Prefer optimized asset in .sphinx/_static if available; fallback to repo image path
const urlRoot = document.body.getAttribute('data-url_root') || '/';
const urlRoot = document.body.getAttribute("data-url_root") || "/";
// Prefer the static bundled logo to avoid path issues
img.src = urlRoot + '_static/ngkore-logo.png';
img.src = urlRoot + "_static/ngkore-logo.png";
// Fallback to absolute path if urlRoot missing
img.onerror = function () {
img.onerror = null;
img.src = '/_static/ngkore-logo.png';
img.src = "/_static/ngkore-logo.png";
};

link.appendChild(img);
container.appendChild(link);
document.body.appendChild(container);
} catch (e) {
console.warn('Failed to attach bottom logo:', e);
console.warn("Failed to attach bottom logo:", e);
}
});


Binary file modified .sphinx/_static/ngkore-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
148 changes: 72 additions & 76 deletions .sphinx/_templates/page.html
Original file line number Diff line number Diff line change
@@ -1,88 +1,84 @@
{% extends "!page.html" %}

{% block extrahead %}
{{ super() }}
{% extends "!page.html" %} {% block extrahead %} {{ super() }}
<!-- Enhanced SEO meta tags -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="theme-color" content="#2196F3">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#2196F3" />

<!-- Topic-specific structured data -->
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "TechnicalArticle",
"publisher": {
"@type": "Organization",
"name": "NgKore",
"url": "https://docs.ngkore.org",
"logo": {
"@type": "ImageObject",
"url": "https://docs.ngkore.org/_static/ngkore-logo.svg"
}
},
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "{{ pageurl|e }}"
},
"headline": "{{ title|e }}",
"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 %}",
"keywords": "{% if meta and meta.keywords %}{{ meta.keywords|e }}{% else %}5G core, post-quantum cryptography, eBPF, O-RAN, network security, NgKore{% endif %}",
"about": [
{
"@type": "Thing",
"name": "5G Core Networks",
"description": "Next-generation mobile network architecture"
},
{
"@type": "Thing",
"name": "Post-Quantum Cryptography",
"description": "Quantum-resistant encryption algorithms"
{
"@context": "https://schema.org",
"@type": "TechnicalArticle",
"publisher": {
"@type": "Organization",
"name": "NgKore Foundation",
"url": "https://docs.ngkorefoundation.org",
"logo": {
"@type": "ImageObject",
"url": "https://docs.ngkorefoundation.org/_static/ngkore-logo.svg"
}
},
{
"@type": "Thing",
"name": "eBPF Technology",
"description": "Extended Berkeley Packet Filter for kernel programming"
"mainEntityOfPage": {
"@type": "WebPage",
"@id": "{{ pageurl|e }}"
},
{
"@type": "Thing",
"name": "O-RAN",
"description": "Open Radio Access Network interoperability"
}
],
"datePublished": "{{ last_updated|e if last_updated else '2023-01-01' }}",
"dateModified": "{{ last_updated|e if last_updated else '2023-01-01' }}"
}
"headline": "{{ title|e }}",
"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 %}",
"keywords": "{% if meta and meta.keywords %}{{ meta.keywords|e }}{% else %}5G core, post-quantum cryptography, eBPF, O-RAN, network security, NgKore{% endif %}",
"about": [
{
"@type": "Thing",
"name": "5G Core Networks",
"description": "Next-generation mobile network architecture"
},
{
"@type": "Thing",
"name": "Post-Quantum Cryptography",
"description": "Quantum-resistant encryption algorithms"
},
{
"@type": "Thing",
"name": "eBPF Technology",
"description": "Extended Berkeley Packet Filter for kernel programming"
},
{
"@type": "Thing",
"name": "O-RAN",
"description": "Open Radio Access Network interoperability"
}
],
"datePublished": "{{ last_updated|e if last_updated else '2023-01-01' }}",
"dateModified": "{{ last_updated|e if last_updated else '2023-01-01' }}"
}
</script>

<!-- Topic breadcrumbs for better SEO -->
{% if parents %}
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{
"@type": "ListItem",
"position": 1,
"name": "NgKore Docs",
"item": "https://docs.ngkore.org/"
}
{% for parent in parents -%}
,{
"@type": "ListItem",
"position": {{ loop.index + 1 }},
"name": "{{ parent.title|e }}",
"item": "{{ parent.link|e }}"
}
{%- endfor %}
,{
"@type": "ListItem",
"position": {{ parents|length + 2 }},
"name": "{{ title|e }}",
"item": "{{ pageurl|e }}"
}
]
}
{
"@context": "https://schema.org",
"@type": "BreadcrumbList",
"itemListElement": [
{
"@type": "ListItem",
"position": 1,
"name": "NgKore Docs",
"item": "https://docs.ngkorefoundation.org/"
}
{% for parent in parents -%}
,{
"@type": "ListItem",
"position": {{ loop.index + 1 }},
"name": "{{ parent.title|e }}",
"item": "{{ parent.link|e }}"
}
{%- endfor %}
,{
"@type": "ListItem",
"position": {{ parents|length + 2 }},
"name": "{{ title|e }}",
"item": "{{ pageurl|e }}"
}
]
}
</script>
{% endif %}
{% endblock %}
{% endif %} {% endblock %}
6 changes: 3 additions & 3 deletions 5g-core/5gc-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
chart from the repository during the API creation. The Helm chart is
then stored locally in the Operator project.
3. **Building the Docker Image** - Once the API and Controller are set
up, we build the ngKore Operator Docker image and then pushed to the
up, we build the 5G Operator Docker image and then pushed to the
Dockerhub registry so it can be accessed and pulled into a
Kubernetes cluster.
4. **Applying the Operator\'s Deployment Manifest** - The Operator is
Expand All @@ -24,11 +24,11 @@
kubectl. The Operator is now running in the cluster.
5. **Creating Instances of the Custom Resource** - We can now start
interacting with the Operator by creating instances of the
**ngkore** custom resource. These instances are defined in YAML and
**5G** custom resource. These instances are defined in YAML and
are applied to the cluster using kubectl. This YAML
defines the desired state of our application.
6. **Reconciliation Loop** - The Operator's controller constantly
watches the ngkore custom resource for changes. If it detects a
watches the 5G custom resource for changes. If it detects a
change, it performs the necessary actions to make the cluster
reflect those changes. This is called the reconciliation loop.
7. **Modifying the Custom Resource** - The 'spec' field in the CR
Expand Down
48 changes: 24 additions & 24 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -92,33 +92,33 @@ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
meet the following conditions:

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

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
stating that You changed the files; and

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

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

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

Copyright 2023 NgKore Community
Copyright 2023-2025 NgKore Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand All @@ -199,4 +199,4 @@ 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.
limitations under the License.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NgKore Documentation

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.
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.

## Contributing

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

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

## License

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

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