Done! Thanks, Dave. On Sun, Mar 23, 2025 at 10:00 AM Dave Fisher <w...@apache.org> wrote:
> Please change “Otava®" to “Otava™” or plain “Otava” > > You can only use ® if a product is a registered trademark. > > Best, > Dave > > > On Mar 22, 2025, at 10:26 PM, Alexander Sorokoumov < > aleksandr.sorokou...@gmail.com> wrote: > > > > Hi team, > > > > https://otava.apache.org/ is live! Check it out and let me know what you > > think. I am happy to address any feedback (or review PRs against > > https://github.com/apache/otava-website/tree/master :) ) > > > > Best, > > Alex > > > > On Mon, Feb 17, 2025 at 10:35 PM Alexander Sorokoumov < > > aleksandr.sorokou...@gmail.com> wrote: > > > >> Hi, > >> > >> As they say, perfect is the enemy of the good, so I decided to push the > >> current state of my work on the website - > >> https://github.com/apache/hunter-website. Since the repository was > empty, > >> my "website-poc-from-asf-template" branch became the default, so you can > >> check it out right there. > >> > >> The website currently contains pretty much the same documentation as > >> https://github.com/apache/hunter/tree/master/docs as well as the link > to > >> the project Github. I've also proactively renamed all occurrences of > >> "hunter" to "otava". > >> > >> My current TODO is to add a community page pointing to this mailing > list, > >> GH issues, and ASF Slack. > >> > >> If you want to try it out locally and are as unfamiliar with the world > of > >> modern javascript as I used to be, you need to install node and npx, > then > >> run "npx docusaurus start" in the project root. > >> > >> Please let me know what you think. What should I add/change before we > >> merge it to master? > >> > >> Best, > >> Alex > >> > >> On Tue, Jan 28, 2025 at 5:53 PM Alexander Sorokoumov < > >> aleksandr.sorokou...@gmail.com> wrote: > >> > >>> Hey! > >>> > >>> The PR with docs has been merged. You can check the current state at > >>> https://github.com/apache/hunter/tree/master/docs. As the next step I > am > >>> going to use Docusaurus to build a website out of it; will let you > know as > >>> soon as I have something to show. > >>> > >>> Best, > >>> Alex > >>> > >>> On Mon, Jan 20, 2025 at 2:04 PM Alexander Sorokoumov < > >>> aleksandr.sorokou...@gmail.com> wrote: > >>> > >>>> Hi all!, > >>>> > >>>> It took me a while, but I have finally opened the first PR with > >>>> documentation and examples - https://github.com/apache/hunter/pull/28 > . > >>>> Please take a look and let me know what you think! > >>>> > >>>> Best, > >>>> Alex > >>>> > >>>> On Tue, Dec 10, 2024 at 6:35 PM Alexander Sorokoumov < > >>>> aleksandr.sorokou...@gmail.com> wrote: > >>>> > >>>>> I'll try Docusaurus then! Thanks for the recommendation, Lari!. > >>>>> > >>>>>> Are you planning to target the > >>>>> https://github.com/apache/hunter-website repository with these PRs ? > >>>>> > >>>>> I would prefer to split the README into markdown documentation files > in > >>>>> apache/hunter to focus on the overall content, then port it over to > >>>>> hunter-website as Docusaurus files focusing on the MDX and nice > formatting. > >>>>> > >>>>> Best, > >>>>> Alex > >>>>> > >>>>> On Tue, Dec 10, 2024 at 5:31 AM Lari Hotari <lhot...@apache.org> > wrote: > >>>>> > >>>>>> On 2024/12/08 22:52:06 Alexander Sorokoumov wrote: > >>>>>>> I do not have any preference at the moment as I haven’t worked yet > >>>>>> with any > >>>>>>> of the discussed options. > >>>>>> > >>>>>> If there's no preference, I'd recommend Docusaurus since it is easy > to > >>>>>> work with and extends to any sorts of websites. The content in > Docusaurus > >>>>>> is in MDX format [1] which allows using React components when that > makes > >>>>>> sense. For example in Pulsar, we have a supported versions [2] > table that > >>>>>> is time based. The download page [3] also uses some dynamic > components. MDX > >>>>>> format is markdown based. Most markdown documents are valid MDX > documents. > >>>>>> There's only a few exception cases where certain characters in the > content > >>>>>> need to be escaped. MDX in Docusaurus supports many plugins such as > >>>>>> automatic syntax highlighters for code blocks and rendering math > >>>>>> expressions with KaTeX [4]. > >>>>>> > >>>>>> 1 - https://mdxjs.com/ > >>>>>> 2 - > >>>>>> > https://pulsar.apache.org/contribute/release-policy/#supported-versions > >>>>>> 3 - https://pulsar.apache.org/download/ > >>>>>> 4 - https://katex.org/ > >>>>>> > >>>>>>> As Henrik mentioned above, I have been working on refactoring > >>>>>> existing > >>>>>>> Hunter docs into multiple pages covering different importers, > >>>>>> exporters, > >>>>>>> individual features, etc. My plan is to replace the “examples” > >>>>>> folder with > >>>>>>> “docs” containing both documentation pages in markdown as well as > >>>>>>> reproducible examples with docker-compose. Then, either try to port > >>>>>> these > >>>>>>> pages to different documentation engines and see/showcase what > seems > >>>>>> to > >>>>>>> work better or use the one we decide on in this thread. > >>>>>>> > >>>>>>> > >>>>>>> I hope to start opening docs PRs in markdown by the end of next > >>>>>> week, in > >>>>>>> case we finish with setting up apache/hunter. > >>>>>> > >>>>>> Are you planning to target the > >>>>>> https://github.com/apache/hunter-website repository with these PRs > ? > >>>>>> > >>>>>> -Lari > >>>>>> > >>>>> > >
