Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Pull function-catalog to have all docs in the same domain #4289

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

Open
lapentad wants to merge 5 commits into kptdev:main
base: main
Choose a base branch
Loading
from Nordix:custom-build-script-netlify
Open
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
9 changes: 9 additions & 0 deletions .gitignore
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@
# See the License for the specific language governing permissions and
# limitations under the License.

# Managed by documentation/Makefile
documentation/content/en/examples/
documentation/content/en/function-catalog
documentation/layouts/shortcodes/listexamples.html
documentation/layouts/shortcodes/listfunctions.html
documentation/layouts/shortcodes/listversions.html
documentation/layouts/shortcodes/relatedexamples.html
documentation/layouts/partials/breadcrumb.html

go.work
go.work.sum
.DS_Store
Expand Down
32 changes: 29 additions & 3 deletions documentation/Makefile
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
EXTERNAL_REPO = https://github.com/kptdev/krm-functions-catalog.git
CLONE_DIR = tmp-krm-clone
CONTENT_SUBDIR = documentation/content/en/function-catalog/
TARGET_HUGO_DIR = content/en/function-catalog/

LAYOUT_SUBDIR = documentation/layouts/
TARGET_HUGO_LAYOUT_DIR = layouts/

EXAMPLES_SUBDIR = examples/
TARGET_HUGO_EXAMPLES_DIR = content/en/examples/

.PHONY: serve production-build preview-build fetch-external-docs

fetch-external-docs:
Copy link
Contributor

@CsatariGergely CsatariGergely Oct 16, 2025

Choose a reason for hiding this comment

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

lapentad reacted with thumbs up emoji
Copy link
Author

Choose a reason for hiding this comment

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

@CsatariGergely I added them now.
Thank you because I did not notice they were not getting rendered

@echo "--- Starting content synchronization from $(EXTERNAL_REPO) ---"
rm -rf $(CLONE_DIR)
git clone --depth 1 $(EXTERNAL_REPO) $(CLONE_DIR)
mkdir -p $(TARGET_HUGO_DIR)
mkdir -p $(TARGET_HUGO_EXAMPLES_DIR)
cp -r $(CLONE_DIR)/$(CONTENT_SUBDIR)* $(TARGET_HUGO_DIR)
cp -r -n $(CLONE_DIR)/$(LAYOUT_SUBDIR)* $(TARGET_HUGO_LAYOUT_DIR)
cp -r $(CLONE_DIR)/$(EXAMPLES_SUBDIR)* $(TARGET_HUGO_EXAMPLES_DIR)
rm -rf $(CLONE_DIR)
@echo "--- External documentation ready in $(TARGET_HUGO_DIR) ---"

serve:
hugo server \
--disableFastRender \
Expand All @@ -12,19 +37,20 @@ serve:
--templateMetricsHints \
--gc

production-build:

production-build: fetch-external-docs
git submodule update --init --recursive
hugo version
hugo \
--minify
npx -y pagefind --site public

preview-build:

preview-build: fetch-external-docs
git submodule update --init --recursive
hugo \
--baseURL $(DEPLOY_PRIME_URL) \
--buildDrafts \
--buildFuture \
--minify
npx -y pagefind --site public

11 changes: 3 additions & 8 deletions documentation/config.toml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,13 @@ copyright = "kpt contributors "
# This menu appears only if you have at least one [params.versions] set.
#version_menu = "Releases"

# Flag used in the "version-banner" partial to decide whether to display a
# Flag used in the "version-banner" partial to decide whether to display a
# banner on every page indicating that this is an archived version of the docs.
# Set this flag to "true" if you want to display the banner.
#archived_version = false

# The version number for the version of the docs represented in this doc set.
# Used in the "version-banner" partial to display a version number for the
# Used in the "version-banner" partial to display a version number for the
# current doc set.
#version = "0.0"

Expand Down Expand Up @@ -171,12 +171,7 @@ yes = 'Glad to hear it! Please <a href="https://github.com/cncf/tag-env-sustaina
no = 'Sorry to hear that. Please <a href="https://github.com/cncf/tag-env-sustainability/issues/new">tell us how we can improve</a>.'

# Adds a reading time to the top of each doc.
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# If you want this feature, but occasionally need to remove the Reading time from a single page,
# add "hide_readingtime: true" to the page's front matter
[params.ui.readingtime]
enable = false

[[menu.main]]
name = "Functions Catalog"
url = "https://catalog.kpt.dev/function-catalog/"
weight = 40

AltStyle によって変換されたページ (->オリジナル) /