Contributor Guide for Adobe Documentation
I den här guiden beskrivs hur du kan bidra till Adobe Enterprise-hjälp för Experience League.
Vad är samarbetsdokumentation?
Den tekniska dokumentationen och aktiveringsinnehållet för Adobe Experience Cloud och andra Adobe Enterprise-produkter bygger på principer med öppen källkod som använder GitHub-, Markdown- och Adobe Experience Cloud-lösningar.
Denna modell med öppen källkod förbättrar innehållskvaliteten och kommunikationen mellan kunder, dokumentationsteam och produktteam. På varje sida kan du nu betygsätta innehållets användbarhet, logga problem och till och med lägga in förslag på innehåll i takt med att Git-förfrågningar skickas (PR). Adobe dokumentationsteam övervakar bidragen och problemen dagligen och gör uppdateringar, förbättringar och justeringar efter behov.
Arbeta med samarbetsdokumentation
Som användare av det här materialet - oavsett om du är anställd, partner, kund eller till och med presumtiv kund - kan du välja att bidra till den här dokumentationen på flera enkla sätt.
- Betygsätt sidans hjälpmedel ❶ och skriv en valfri kommentar ❷
- Rapportera ett problem mot en viss sida (kräver Git-inloggning) ❸
- Skicka en snabb redigering till för att skapa hela artiklar, komplett med resurser och kodexempel (kräver Git-inloggning) ❹
Dessa alternativ visas längst ned på sidan några sekunder efter att den har öppnats. Om du stänger feedbackområdet kan du läsa in sidan igen för att få tillbaka den.
I den här guiden beskrivs vad du behöver veta för att interagera med och bidra till materialuppsättningen.
Betygsätt hur hjälpsam sidan är och skriv en kommentar
Några sekunder efter att du har öppnat en sida visas ett feedbackområde längst ned på sidan. Klicka uppåt eller nedåt för att ange om sidan var till hjälp.
Lämna gärna en kommentar för att lämna ytterligare feedback.
Redigera snabbt befintliga dokument
Om du vill ge mer detaljerad feedback är det ett bra sätt att åtgärda små fel och utelämnanden i dokument genom att göra snabba ändringar. När du föreslår en redigering skickar du en pull-begäran (PR) för att skicka korrigeringen/förslaget till oss, och vi kan granska, godkänna och publicera förslaget.
-
Underteckna Contributor-licensavtalet (CLA) om det går.
You only need to submit an Adobe CLA one time.
-
I det feedbackområde som visas längst ned i artikeln klickar du på Detailed feedback options och sedan på Suggest an edit för att gå till markeringskällfilen på GitHub.
-
Click the pencil icon to edit the article.
note NOTE If the pencil icon is grayed out, you need to login to your GitHub account, or create a new account. -
Make your changes in the web editor.
You can click the Preview changes tab to check formatting of your change.
-
När du har gjort ändringarna bläddrar du längst ned på sidan.
Enter a title and description for your PR, then click Propose file change as shown in the following figure:
note NOTE If you get a validation error message about signing a Contributor License Agreement (CLA), click Details to open the license agreement. Sign the agreement, if acceptable. Then close and open pull request, and continue.
Det är allt som finns för det. Documentation team members will review and merge your pull request. Thank you!
Report an issue
Another easy way to let us know about a problem with a piece of content is to use Report an issue.
-
I det feedbackområde som visas längst ned i artikeln klickar du på Detailed feedback options och sedan på Report an issue för att gå till markeringskällfilen på GitHub.
note NOTE To report an issue, you must log in to your GitHub account, or create an account. Clicking this link allows you to log a quick ticket with Experience League, using the Github Issue interface.
URL:en för sidan med problemet fylls i automatiskt i beskrivningsfältet.
-
Fyll i rubriken, skriv en kort beskrivning av problemet och klicka sedan på Skicka nytt problem.
Om du skickar in ett problem meddelas innehållsteamet för den här sidan, som kan åtgärda problemet. När vi har uppdaterat innehållet får du veta det i gränssnittet för Github Issues och du får ett e-postmeddelande när det uppdateras eller stängs.
Förstå GitHub-behörigheter
Gränssnittet för GitHub-redigering anpassas till dina databasbehörigheter. Bilderna ovan gäller för medarbetare som inte har skrivbehörighet till måldatabasen. GitHub skapar automatiskt en gaffel av måldatabasen i ditt konto. Om du har skrivåtkomst till måldatabasen skapar GitHub en ny gren i målrapporten.
Adobe använder pull-begäranden för alla ändringar, även för medarbetare som har skrivbehörighet. De flesta databaser har grenen main skyddad så att uppdateringar måste skickas som pull-begäranden.
Redigeringsfunktionen i webbläsaren passar bäst för smärre eller ovanliga ändringar. Om du ger stora bidrag eller använder avancerade Git-funktioner rekommenderar vi att du förser ombudet och arbetar lokalt.
Ge feedback
Med en lösning som är lika stor som Adobe är dokumentationen alltid ett pågående arbete. Om du upptäcker fel bör du logga ett problem och informera oss om du har förslag på material. Berätta vilken information du sökte efter. Meddela oss om du inte hittar det du behöver, eller om du har problem med att slutföra din uppgift, var vänlig och tala om för oss hur vi kan hjälpa dig att lära dig våra lösningar.
Tack från Collaborative Documentation Team och alla skribenter och innehållsproducenter i Experience League. Tack för din hjälp.