Comments (5)
We need to talk with IT team
from bonita-documentation-site.
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.
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.
- 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.
solutions put in place, so closing
from bonita-documentation-site.
Related Issues (20)
- Enable dependabot in doc content repositories to update github actions HOT 2
- Simplify doc content reviewer life: warn about aliases when pages have changed
- The Vale syntax checker should not set the PR in error HOT 9
- Use bonitasoft/actions notify-slack
- Limit maintenance in the push-content.yml workflow of documentation content repositories
- Update component name in documentation content test data
- DocSearch: Improve records indexation on big documentation page HOT 5
- "Resource not accessible by integration" when pushing to production HOT 1
- Apply the "images compression" workflow to doc content repositories without duplication
- Apply the "Vale checks" to doc content repositories without duplication HOT 1
- The "Publish PR preview" workflow fails in PR that update the theme
- The "Publish PR preview" workflow fails with branch name containing parentheses HOT 1
- "Publish PR preview" comments: don't include extra files in the list of pages
- Wrong characters in the slack message sent when the "push to production" job fails
- Add automatic tests for custom Antora extensions
- Handle "pre-release" versions in the "comment-pr-with-url-links" action
- The slack notification is no more received when the "Propagate documentation " workflow failed HOT 2
- Only index the latest versions of a component in Google, Bing, ...
- Reporting a vulnerability HOT 2
- Reporting a vulnerability HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from bonita-documentation-site.