search

open-telemetry / opentelemetry-sqlcommenter

SQLCommenter components for various languages
Apache License 2.0
27 stars 12 forks source link

Migrating SQLCommenter document from google to opentelemetry. #7

Closed sjs994 closed 2 years ago

sjs994 commented 2 years ago

Steps done here:

  1. Created a new branch for documentation (reason: to separate the doc commits from commits in source code of sqlcommenter)
  2. Added the source code of the document and then in the next commit renamed all the links pointing to google repository to open-telemetry repository.
  3. Generated the document.
  4. Moved LICENSE and README file to root folder.
sjs994 commented 2 years ago

After these changes are checked-in we will provide the docs link to github-pages to publish the document.

aabmass commented 2 years ago

@sjs994 should the documentation source live in main and then the built documents will be the only thing in gh-pages branch?

sjs994 commented 2 years ago

@sjs994 should the documentation source live in main and then the built documents will be the only thing in gh-pages branch?

Yes that would be better. With this though, there will be some back and forth between branches for generating the docs. Let me check some ways to make the document generation process easy. Moving this PR to draft for now.