Git Product home page Git Product logo

inlong-website's Introduction

InLong Official Website

This project keeps all sources used for building up InLong official website which's served at https://inlong.apache.org/

Prerequisite

InLong website is powered by Docusaurus. If your version of Docusaurus is less than 2.0.0,please upgrade to 2.0.0. Please also make sure your node version is 16.14.x, versions higher than 16.14.x is not supported by Docusaurus yet.

Build instruction

  1. Run npm i in the root directory to install the dependencies.
  2. Run npm start in the root directory to start a local server, you will see the website in 'http://127.0.0.1:3000'.
  3. Run npm run build to build source code.

If you need to see the documentation in simplified Chinese, first npm run build, then use npm run start-zh.

If you have higher version of node installed, you may consider nvm to allow different versions of node coexisting on your machine.

  1. Follow the instructions to install nvm
  2. Run nvm install v16.14.0 to install node v16
  3. Run nvm use v16.14.0 to switch the working environment to node v16

Then you are all set to run and build the website. Follow the build instruction above for the details.

How to send a PR

Make sure you have submit issue for tracking PR: https://github.com/apache/inlong/issues

  1. Do not use git add . to commit all the changes.
  2. Just push your changed files, such as:
    • *.md
    • blog.js or docs.js or site.js
  3. Send a PR to master branch.

Guide for adding new document

Add a new article for docs

  1. Add new .md file under docs or i18n.
  2. Run dev server locally to verify the article can be displayed correctly.
  3. Send the pull request contains the *.md and development.js only.

Add a new version for documents

  1. Modify the document in docs, then run npm run docusaurus docs:version replace_by_target_version locally to copy a document.
  2. Add a label to DOC's item in docusaurus.config.js file.
  3. Modify the last table version in /src/pages/version/index.js.

inlong-website's People

Contributors

aloyszhang avatar baomingyu avatar bluewang avatar cku328 avatar dependabot[bot] avatar dockerzhang avatar doleyzi avatar e-mhui avatar emsnap avatar featzhang avatar gong avatar gosonzhang avatar guangxucheng avatar haifxu avatar healchow avatar hnrainll avatar kevinwen007 avatar kipshi avatar leezng avatar liaorui avatar liaosunny123 avatar luchunliang avatar oneal65 avatar thesumery avatar tisonkun avatar vernedeng avatar wf123537200 avatar woofyzhao avatar xuesongxs avatar yunqingmoswu avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

inlong-website's Issues

[Sort] Add Kafka/Iceberg/Hive load nodes guide

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Add document for introducing how to extend a new type of sin in sort

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

some links in release template are incorrect

Expected behavior

all the links should be offical and correct

Actual behavior

some links in the release template are incorrect, such as links for tag and KEY FILE

Steps to reproduce

see the how to release template

System configuration

Add Inlong Manager Client developer doc

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Manager] Update the documentation for managerctl

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Update InLong Team member information

Update Committer and PPMC personnel list information based on data as of 2022-04-06

  1. Add leezng as Committer
  2. Add shink as Committer
  3. Modify healzhou from Committer to PPMC

[Sort] Add some data node detail doc

Add data node detail doc. node include kafka extract node、postgres extract node、clickhouse laod node、greenplum load node、hbase load node、kafka load node、mysql load node、oracle load node、postgres load node、sql server load node、TDSQL Postgres load node.

Modify part of the description in the office-web document

Is your feature request related to a problem? Please describe.

Modify part of the description in the office-web document, including the modification of bid and tid.

Describe the solution you'd like

A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context

Add any other context or screenshots about the feature request here.

[Manager] Add Auto Push Description

Is your feature request related to a problem? Please describe.
Add Auto Push Description

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Security] Workflow deploy.yml is using vulnerable action peaceiris/actions-gh-pages

The workflow deploy.yml is referencing action peaceiris/actions-gh-pages using references v2.4.0. However this reference is missing the commit d2178821cb5968f5b7c818210297f3dbeea3114c which may contain fix to the some vulnerability.
The vulnerability fix that is missing by actions version could be related to:
(1) CVE fix
(2) upgrade of vulnerable dependency
(3) fix to secret leak and others.
Please consider to update the reference to the action.

[Feature] [InLong-Agent] Modify bid and tid to inlongGroupId and inlongStreamId

Is your feature request related to a problem? Please describe.

In the current agent module, the bid and tid (or dsid) fields are not easy to understan, so modified them to inlongGroupId and inlongStreamId.

Actual behavior
Modify bid and tid to inlongGroupId and inlongStreamId

Steps to reproduce
System configuration
InLong version: x.y

[Sort] Add usage document for MySQL Extract Node, Elasticsearch Load Node

Is your feature request related to a problem? Please describe.

MySql Extract Node, Elasticsearch Load Node is missing some usage documentation here.

Describe the solution you'd like

Add usage document for MySQL Extract Node, Elasticsearch Load Node.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Sort] Add ClickHouse Load node guide

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

add Inlong manager user defined Shiro plugin documentation

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Refactor the File collector guide

Is your feature request related to a problem? Please describe.
refactor the File collector guide

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Sort] Add MySQL/Kafka extract not load guide

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

add Add Shiro interface for manager authorization

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Bug][Manager] Incorrect register key in doc

https://inlong.apache.org/docs/modules/manager/quick_start

On the "Register Message Queue" section some of the extParams keys are incorrect according to InlongGroupSettings definition.
For example "pulsar_adminUrl" should actually be "pulsar.adminUrl". And the tube keys also don't match up.

/**
 * config of pulsar
 */
public static final String PULSAR_ADMIN_URL = "pulsar.adminUrl";

public static final String PULSAR_SERVICE_URL = "pulsar.serviceUrl";

public static final String PULSAR_AUTHENTICATION = "pulsar.authentication";

public static final String PULSAR_AUTHENTICATION_TYPE = "pulsar.authentication.type";

public static final String DEFAULT_PULSAR_AUTHENTICATION_TYPE = "token";

/**
 * config of tube mq
 */
public static final String TUBE_MANAGER_URL = "tube.manager.url";

public static final String TUBE_MASTER_URL = "tube.master.url";

public static final String TUBE_CLUSTER_ID = "tube.cluster.id";

add 1.1.0 release blog

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Change TubeMQ to Apache InLong

Expected behavior

image

Actual behavior

Should change to Apache InLong

Steps to reproduce

System configuration

InLong version: x.y

Add Inlong Manager Plugin develop docs

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Website: Request to add a search function to the site

Just as I described in the title, I want to provide the search box feature for our official website. I'm sorry for the delay due to my thesis. I will finish this task in the next time.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

mention #1831

Describe the solution you'd like
A clear and concise description of what you want to happen.

choose Algolia.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

[Doc] Fix typo in docs

Expected behavior

Tell us what should happen

Actual behavior

Tell us what happens instead

Steps to reproduce

How can we reproduce the issue

System configuration

InLong version: x.y

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.