Giter Site home page Giter Site logo

Adding a <note> to the "Adding new diagnostic messages" topics explaining what needs to be done to show an <ouput-message> in the Oxygen Results view. about docs HOT 12 CLOSED

stefan-jung avatar stefan-jung commented on August 22, 2024
Adding a to the "Adding new diagnostic messages" topics explaining what needs to be done to show an in the Oxygen Results view.

from docs.

Comments (12)

raducoravu avatar raducoravu commented on August 22, 2024 2

@xephon2 I do not know. That's the simple answer.
So we have this situation where there is a main GitHub repository like dita/dita-docs and someone does not have access rights to directly commit to it. That someone also has an old fork of the dita-docs in their account. When you attempt to edit and commit content from dita/dita-docs our WebAuthor will attempt to create a branch on that old fork "stefan/dita-docs" containing the latest changes that you made and also to possibly start a pull request.
We use some APIs to create the branch, sometimes the GitHub APIs fail without returning a proper error message (the GitHub APIs do not return very clear error messages from what I figured, probably not to help hackers exploit vulnerabilities). That's why you also receive that not helpful message not authorized exception. From what I tested it may happen that the API manages to create a branch even if the fork is a little bit stale (creating a branch worked for a fork which was about 3 commits behind than the main project) but it may fail to do so if the fork is very stale (creating a branch did not work if the fork was 300 commits behind the original repository). What I tried yesterday was that if creating a branch from the fork containing content from the original topic in the main repository failed to automatically synchronize your fork to the main repository (that "Sync fork" button which appears on each fork in the GitHub page, but called automatically) before creating the branch.

from docs.

raducoravu avatar raducoravu commented on August 22, 2024 1

We reproduced and added an internal issue for @xephon2 's problem of creating a pull request. He has an old fork of the dita ot docs project which is not up to date and this is possibly the cause. Basically if Stefan deletes the old fork and tries again to commit using WebAuthor, things should probably start working.

from docs.

raducoravu avatar raducoravu commented on August 22, 2024 1

@xephon2 For completion we made some changes to the WebAuthor on our website, updated it to version 25.1, it should probably handle better such situations in which the fork of a project like the dita-docs is outdated and you attempt to create a commit and a pull request using it. But I cannot guarantee it will work in all cases.

from docs.

infotexture avatar infotexture commented on August 22, 2024

I tried the Edit this page button but I do not have to permissions to commit and add a pull request.

@xephon2 That's odd. 🤔

If you don't have push rights to the repo, oXygen XML Web Author should prompt you to sign in to GitHub, fork the dita-ot/docs repository (if you haven't already), and create the PR from your fork.

@raducoravu: Has this workflow changed recently in the web author tool?

from docs.

infotexture avatar infotexture commented on August 22, 2024

As for the suggestion itself, I'm not sure we should mention oXygen here, as there's already a note that mentions the ID prefix convention:

Note: By convention, the toolkit messages use DOTX but any sequence can be used by plug-in developers.

I suppose we could extend that to mention that some tools may use this prefix when parsing logs.

I've always thought of the DOT* prefixes as something reserved for the toolkit itself, and that messages from custom plug-ins would use their own prefixes and numbers, like ACME123E, so any company-specific parsers would pick these up.

@jelovirt @robander Any thoughts on this?

from docs.

raducoravu avatar raducoravu commented on August 22, 2024

The "Edit this page" link which appears for each doc topic seems to work fine for me.
Screenshot 2022-12-05 at 08 26 37
About this request, I consider it to be a bug in Oxygen that it does not gather all message IDs, no matter what ID pattern they have, so this is not related to how the DITA OT works.

from docs.

robander avatar robander commented on August 22, 2024

I've always thought of the DOT* prefixes as something reserved for the toolkit itself, and that messages from custom plug-ins would use their own prefixes and numbers, like ACME123E, so any company-specific parsers would pick these up.

@jelovirt @robander Any thoughts on this?

Agreed, I've used company-specific prefixes in all of my plugins.

from docs.

stefan-jung avatar stefan-jung commented on August 22, 2024

@raducoravu and @infotexture , this is how it looks on my private computer.
grafik
grafik

from docs.

infotexture avatar infotexture commented on August 22, 2024

Thanks for the info in the comments above.

The last screenshot suggests something may be wrong with the step where oXygen selects the repo fork to submit the PR from, but I'll leave that for @xephon2 & @raducoravu to discuss separately.

from docs.

raducoravu avatar raducoravu commented on August 22, 2024

I will ask my colleagues from the WebAuthor team to take a look at the screenshots @xephon2 pasted above. I also consider the DOT... message IDs should be "reserved" for the DITA OT and Oxygen should try to do a better job at gathering other message ID patterns as well.

from docs.

stefan-jung avatar stefan-jung commented on August 22, 2024

@raducoravu could you please define what "old" means? 100 days, 1000 commits? Let's say we're going to use this in our company environment and someone triggers a PR and the next one after half a year, then probably 5000 commits will be between the new and the previous PR. Would you consider this to be "old"?

from docs.

stefan-jung avatar stefan-jung commented on August 22, 2024

from docs.

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.