Skip to content
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

Documentation completely transferred to markdown #54

Closed
wants to merge 7 commits into from
Closed

Documentation completely transferred to markdown #54

wants to merge 7 commits into from

Conversation

skunert
Copy link
Contributor

@skunert skunert commented Jul 1, 2014

This commit contains the rest of the documentation transferred to markdown.

@skunert
Copy link
Contributor Author

skunert commented Jul 1, 2014

I changed the gh_link script a bit to support custom naming of the link. The last argument is now always the name of the link. The downside is that if you want to name the link you have to also insert the branch.

Example
{% gh_link README.md master This is the readme file %}

Even though it is not that elegant that the last 5 arguments build the name string I think it is a necessary feature for the documentation. I also found some links that are still incorrect so this is not yet finished.

@rmetzger
Copy link
Contributor

rmetzger commented Jul 2, 2014

Regarding the gh_link plugin: Can't we pass a null value or something if we don't want to specify the branch?

@@ -162,7 +164,7 @@ setFinalState(solution);
In the following example, every vertex has an **ID** and a **coloring**. Each vertex will propagete its vertex ID to neighboring vertices. The **goal** is to *assign the minimum ID to every vertex in a subgraph*. If a received ID is smaller then the current one, it changes to the color of the vertex with the received ID. One application of this can be found in *community analysis* or *connected components* computation.

<p class="text-center">
<img alt="Delta Iterate Operator Example" width="100%" src="{{ site.baseurl }}/docs/0.4/img/iterations_delta_iterate_operator_example.png" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Did we remove the site.baseurl everywhere? I think its a quite useful feature.

Copy link
Contributor

Choose a reason for hiding this comment

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

The idea was to remove it from the links to other doc pages. That's why we now have a flat hierarchy of MD files.

@rmetzger
Copy link
Contributor

rmetzger commented Jul 2, 2014

Thanks alot for doing this. It is very important for our project to have a good, up-to-date documentation.
I know that its sometimes annoying to do documentation, so I highly appreciate that you did the pull request!

@skunert
Copy link
Contributor Author

skunert commented Jul 2, 2014

Thats what I meant with the last sentence of the PR. There are still a lot of links missing, I will fix this.

@rmetzger
Copy link
Contributor

rmetzger commented Jul 2, 2014

Okay. Thank you!

@rmetzger
Copy link
Contributor

rmetzger commented Jul 3, 2014

Whats your timeline regarding the documentation? Make sure to merge my pull request first https://github.com/skunert/incubator-flink/pull/1 It changes some stuff in the documentation.

I'm asking because I want to push a first version of the website soon. Maybe I'll just merge the current state of your documentation rework and you'll open a second pull request for the remainder.

@skunert
Copy link
Contributor Author

skunert commented Jul 3, 2014

Hi, i just updated a lot of links in the documentation. It takes some time because I need to double check everything and there is lots of stuff.

I did not see your PR, will look at it now.

And i have a question about the use of "Stratosphere" in the code. Since the documentation is already called "Flink Documentation" we can use the new name already?

Also the gh_link plugin now uses whatever string put in "" as name.

Example:
{% gh_link README.md "Name" %}
{% gh_link README.md master "Name" %}
{% gh_link README.md "Name" master %}

@asfgit asfgit closed this in 5928706 Jul 4, 2014
zhijiangW pushed a commit to zhijiangW/flink that referenced this pull request Jul 23, 2019
tzulitai pushed a commit to tzulitai/flink that referenced this pull request Jan 15, 2021
morozov pushed a commit to morozov/flink that referenced this pull request Apr 26, 2024
…o enable mongodb connector to run with decodable-flink (apache#54)

* [FLINK-28417][table] Add interfaces for LookupCache and default implementation (apache#20196)

* manually add ThreadSafeSimpleCounter, which is the only missing dependency of LookupCache/DefaultLookupCache that is not in flink 1.15

---------

Co-authored-by: Qingsheng Ren <renqschn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants