You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by "GreatEugenius (via GitHub)" <gi...@apache.org> on 2025/09/11 02:58:00 UTC
[PR] [docs] Set up Flink Agents Document Website [flink-agents]
GreatEugenius opened a new pull request, #155:
URL: https://github.com/apache/flink-agents/pull/155
<!--
* Thank you very much for contributing to Flink Agents.
* Please add the relevant components in the PR title. E.g., [api], [runtime], [java], [python], [hotfix], etc.
-->
<!-- Please link the PR to the relevant issue(s). Hotfix doesn't need this. -->
Linked issue: #154
### Purpose of change
Set up Flink Agents Document Website.
<!-- What is the purpose of this change? -->
### Tests
<!-- How is this change verified? -->
### API
<!-- Does this change touches any public APIs? -->
### Documentation
<!-- Should this change be covered by the user documentation?-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs] Set up Flink Agents Document Website [flink-agents]
Posted by "Sxnan (via GitHub)" <gi...@apache.org>.
Sxnan commented on code in PR #155:
URL: https://github.com/apache/flink-agents/pull/155#discussion_r2339856530
##########
docs/config.toml:
##########
@@ -0,0 +1,92 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+baseURL = '//nightlies.apache.org/flink/flink-agents-docs-main'
+languageCode = "en-us"
+title = "Apache Flink Agents"
+enableGitInfo = false
+theme = "book"
+pygmentsUseClasses = true
+
+[params]
+ # Flag whether this is a stable version or not.
+ # Used for the quickstart page.
+ IsStable = false
+
+ # Flag to indicate whether an outdated warning should be shown.
+ ShowOutDatedWarning = false
+
+ # This are the version referenced in the docs. Please only use these variables
+ # to reference a specific Flink Agents version, because this is the only place where
+ # we change the version for the complete docs when forking of a release branch
+ # etc.
+ # The full version string as referenced in Maven (e.g. 1.2.1)
+ Version = "1.0-SNAPSHOT"
Review Comment:
The version is inconsistent with the version in `pom.xml` or `pyproject.toml`.
##########
docs/content/_index.md:
##########
@@ -0,0 +1,44 @@
+---
+title: Apache Flink Documentation
+type: docs
+bookToc: false
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you 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.
+-->
+
+# Apache Flink Agents Documentation
+
+{{< columns >}}
+## Try Flink Agents
+
+If you’re interested in playing around with Flink Agents, check out our [example codes]({{< ref "docs/try-flink-agents/installation" >}}).
+It provides a step by step introduction to the APIs and guides you through real applications.
+
+<--->
+
+## Get Help with Flink Agents
+
+If you get stuck, check out our [community support resources](https://flink.apache.org/community.html).
Review Comment:
We may copy the Community section in README to here
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs] Set up Flink Agents Document Website [flink-agents]
Posted by "GreatEugenius (via GitHub)" <gi...@apache.org>.
GreatEugenius commented on PR #155:
URL: https://github.com/apache/flink-agents/pull/155#issuecomment-3277203230
@Sxnan please help take a look this PR, thanks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] [docs] Set up Flink Agents Document Website [flink-agents]
Posted by "xintongsong (via GitHub)" <gi...@apache.org>.
xintongsong merged PR #155:
URL: https://github.com/apache/flink-agents/pull/155
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org