Alex,
Thanks a lot for preparing the list. It's truly handy. We'll take care of
all the unassigned tickets by reaching out to the contributors.
-
Denis
On Thu, Aug 6, 2020 at 4:13 AM Alex Plehanov
wrote:
> Artem,
>
> Ok, let's suggest edits for 2.9 release documentations via pull request to
Artem,
Ok, let's suggest edits for 2.9 release documentations via pull request to
ignite-7595 branch if there are no other objections.
чт, 6 авг. 2020 г. в 13:20, Artem Budnikov :
> Alex,
>
> The documentation source files are still in the IGNITE-7595 branch. I
> haven't pushed them to the
Alex,
The documentation source files are still in the IGNITE-7595 branch. I
haven't pushed them to the master yet, but I can do so if it is
necessary. Or, you can add your changes to this branch. I added an
instruction on how to contribute:
Denis, Artem,
I've marked the "tracing" ticket as important.
Also, I've added a new section to the release page [1] and created
documentation tickets for some features. Now there is a documentation
ticket exists for each important feature implemented in 2.9.
I know that some Igniters are
Hi Alex,
Certainly, the new documentation should not be treated as a showstopper,
and if the code is ready much earlier, then we can release the docs on
readme.io.
But, it's not clear what's the documentation readiness status. As per our
updated release process, the docs need to be ready before
Denis,
We have some performance drop on benchmarks, so we need some time to find
problematic commit and analyze it. I hope this will be completed during the
current week and we move to the "Vote preparation" phase to the start of
next week.
I think waiting for another month due to documentation
I would wait for 3-4 weeks and release the new docs in 2.9. It means that
the release should be announced the first week of September which is not a
huge slip. Moreover, it feels like the testing phase and release procedures
will not be completed sooner.
So, I would suggest contributing 2.9
Hi Maxim,
The new docs project is not finished yet. There are still a lot of pages
to port to the new format, and we are still working on the integration
with the web-site. Nevertheless, we can try to publish the Ignite 2.9
documentation on the web-site in the new format. The documentation
Artem,
I'd like to submit some documentation changes for 2.9 release. Should
I update docs on readme.io or publish it on ignite.apache.org?
On Wed, 29 Jul 2020 at 19:06, Artem Budnikov
wrote:
>
> Hi Alex,
>
> Sorry, I missed this message. There is still a lot of work on the docs.
> When is
Hi Alex,
Sorry, I missed this message. There is still a lot of work on the docs.
When is version 2.9 going to be released?
-Artem
On 22.07.2020 10:35, Alex Plehanov wrote:
Guys,
What about documentation for 2.9 release? Are we going to publish it on
readme.io or publish it on
Guys,
What about documentation for 2.9 release? Are we going to publish it on
readme.io or publish it on ignite.apache.org?
What about new edits? Should we still edit pages on readme.io or already
make changes in git repository?
Artem, could you please clarify the current documentation workflow?
Denis,
How about the next step of taking the HTML and committing it to the website
repository? Did you have a chance to think through this step?
Yes, I'll look into this this week. This shouldn't be very difficult.
-Artem
On 18.07.2020 00:43, Denis Magda wrote:
Worked out well on my end.
Worked out well on my end. Thanks for sending the update!
How about the next step of taking the HTML and committing it to the website
repository? Did you have a chance to think through this step?
-
Denis
On Fri, Jul 17, 2020 at 5:27 AM Artem Budnikov
wrote:
> Hi everyone,
>
> I've prepared
Hello!
I was able to eventually run it. The trick is to only install bundler with
apt, and not jekyll, once you install any other gems, they collide and it
will fail.
Looks OK. For some reason "Working with SQL" leads nowhere.
Regards,
--
Ilya Kasnacheev
пт, 17 июл. 2020 г. в 15:27, Artem
Hi everyone,
I've prepared the initial set of source files for the Ignite
documentation. If you are interested, you can take a look at
https://github.com/apache/ignite/tree/IGNITE-7595/docs
You can run a local web-server (jekyll) if you want to view the docs in
your browser. Refer to the
+1 for migrating docs to github. It will allow an easier contribution for
docs, I think. As a nice feature - adding an edit link (submit PR for docs)
to the document page on site.
As for keeping them separate - Microsoft keeps docs for it's products in
separate repos, for example.
On Thu, 25 Jun
OK, let's give it a try.
The way I see it, the documentation source files will be located in the
"/docs" folder, including UI templates/styles, asciidoc files, and build
scripts. I'll start experimenting with this and will let you know when
basic setup is ready.
-Artem
On 23.06.2020 20:19,
I believe that by keeping the documentation sources in the same repository
with the source code will help us to prepare and release all the release
artifacts at the same time. So, +1 for hosting raw documentation ascii-doc
pages in the main Ignite repo. However, the HTML version needs to reside on
+1 to keep docs and sources together.
-1 to keep docs in external repository.
> 23 июня 2020 г., в 16:47, Artem Budnikov
> написал(а):
>
> Pavel,
>
>> I don't think so: we can't add snippets pointing to new APIs from a separate
>> repo,
> Snippets are kept together with the docs, they /don't
Pavel,
I don't think so: we can't add snippets pointing to new APIs from a
separate repo,
Snippets are kept together with the docs, they /don't need/ to be stored
in the main repo, although they can. They are compilable and up to date.
I update the docs and API samples for features that
Pavel,
As far as I can see, all your pros points work just as well for a
separate repository (except for "everybody knows about it"). I don't
mind keeping the docs in Ignite repo as long as I am able to freely
commit to master. Will I be able to do that?
-Artem
On 23.06.2020 14:04, Pavel
Ilya, Artem,
"Separate repo just because we can't finish docs before release"
does not make sense to me. My proposal is:
- Working version is in the master branch
- When a release branch is created, e.g. ignite-2.9, we create
ignite-2.9-docs and update it as long as we want.
Pros (compared to a
Pavel,
Yes, I mean a separate repository. The reason is that documentation is
usually updated after the product version is released. As Ilya pointed
out, keeping the docs in the main Ignite repository would entail
completing the docs before the release date, which is not possible under
Hello!
I'm not really sold on the github version yet, I would like to see a
prototype of such documentation before deciding, so for me it'w
0
Pavel, we don't have enough discipline to make sure that all documentation
is ready at the time of release, and we may need to add notices here and
there
+1
> stored in a github repository
Do you mean a separate repository here?
I think we should use the main Ignite repo for documentation.
On Tue, Jun 23, 2020 at 10:21 AM Nikita Amelchev
wrote:
> +1
> For now it's unclear how to add new pages to the site. I hope it'll be
> a clear process.
>
+1
For now it's unclear how to add new pages to the site. I hope it'll be
a clear process.
вт, 23 июн. 2020 г. в 10:06, Alexey Zinoviev :
>
> I'd like this approach, it's easier for contributors to suggest edits.
> +1
>
> вт, 23 июн. 2020 г. в 10:03, Nikolay Izhikov :
>
> > +1.
> >
> > > 23 июня
I'd like this approach, it's easier for contributors to suggest edits.
+1
вт, 23 июн. 2020 г. в 10:03, Nikolay Izhikov :
> +1.
>
> > 23 июня 2020 г., в 10:02, Artem Budnikov
> написал(а):
> >
> > Hello Igniters,
> >
> > I'd like to return to the discussion about migrating the Ignite
>
+1.
> 23 июня 2020 г., в 10:02, Artem Budnikov
> написал(а):
>
> Hello Igniters,
>
> I'd like to return to the discussion about migrating the Ignite documentation
> from readme.io to github. The idea emerged long time ago [1] but hasn't been
> implemented. I think now is the time to make it
Hello Igniters,
I'd like to return to the discussion about migrating the Ignite
documentation from readme.io to github. The idea emerged long time ago
[1] but hasn't been implemented. I think now is the time to make it happen.
Here are the technical details of the proposed solution:
* docs
29 matches
Mail list logo
