Giter Site home page Giter Site logo

Comments (5)

benjaminParisel avatar benjaminParisel commented on August 14, 2024

We need to talk with IT team

from bonita-documentation-site.

nchabanoles avatar nchabanoles commented on August 14, 2024

I think it is important the the Javadoc can be browsed online and not only in an IDE. That is the reason why Java itself let developper browse their API online. The same way many product do.

Now I agree, we need to find a solution that is easy to maintain and that do not require many manual actions to release.

Here are my thoughts on the requirements (I'll let you discuss the potential solutions):

  • the javadoc should be accessible from the doc-site (either embedded or link to another hosting, for now I do not know if it matters to me)
  • the javadoc should contain both Community and Enterprise APIs, to let developers have the full picture in one place

from bonita-documentation-site.

jbaudot85 avatar jbaudot85 commented on August 14, 2024

I like above solutions 2 and 4 ("push the javadoc to a dedicated repository that will host a gh-pages branch" and "create a javadoc Antora component and store the static file in a dedicated branch of bonita-doc or in a new repository").

They seem equivalent solutions and inline with nicolas' requirements as soon as pointed out by the docsite.

from bonita-documentation-site.

benjaminParisel avatar benjaminParisel commented on August 14, 2024
  • IT Team need to deployed the javadoc somewhere (github repository with github could be great): urls remains the same, see #68 (comment)
  • Replace the oldest link of javadoc with newest --> redirects have been configured, doc content updates could be managed with #191

from bonita-documentation-site.

tbouffard avatar tbouffard commented on August 14, 2024

solutions put in place, so closing

from bonita-documentation-site.

Related Issues (20)

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.