Skip to content

Introduce Documentation for Remorph#1460

Merged
jimidle merged 15 commits intomainfrom
feature/remorph_docs
Mar 27, 2025
Merged

Introduce Documentation for Remorph#1460
jimidle merged 15 commits intomainfrom
feature/remorph_docs

Conversation

@sundarshankar89
Copy link
Collaborator

  • Docusarus for writing documentation
  • Baseline Documentation
  • Introduce Search lunrjs
  • Customisation using Tailwind.css

@sundarshankar89
Copy link
Collaborator Author

@biswadeepupadhyay-db tagging you to take it forward

@databrickslabs databrickslabs deleted a comment from Biswadeep27 Feb 25, 2025
@biswadeepupadhyay-db
Copy link
Contributor

Acknowledged.

@sundarshankar89
Copy link
Collaborator Author

Landing Page:

image

Sidebar Layout:

image

@sundarshankar89
Copy link
Collaborator Author

Search:
image

@sundarshankar89 sundarshankar89 marked this pull request as ready for review February 25, 2025 12:57
@sundarshankar89 sundarshankar89 requested a review from a team as a code owner February 25, 2025 12:57
@github-actions
Copy link

github-actions bot commented Feb 25, 2025

✅ 13/13 passed, 1 skipped, 10s total

Running from acceptance #315

@sundarshankar89
Copy link
Collaborator Author

Refactor docs post merge of this PR #1459

Copy link
Collaborator

@gueniai gueniai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good as a the first pass, there are many pages that we'll need to revisit. We need to take out the contributing portion of the docs out, and maybe keep these in a google doc internally since for the time being we're not expecting external contributions of any kind.

@sundarshankar89
Copy link
Collaborator Author

Overall this looks good as a the first pass, there are many pages that we'll need to revisit. We need to take out the contributing portion of the docs out, and maybe keep these in a google doc internally since for the time being we're not expecting external contributions of any kind.

I feel otherwise having it in the project is good practice, we can change the wordings if we would like

@gueniai
Copy link
Collaborator

gueniai commented Mar 5, 2025

Overall this looks good as a the first pass, there are many pages that we'll need to revisit. We need to take out the contributing portion of the docs out, and maybe keep these in a google doc internally since for the time being we're not expecting external contributions of any kind.

I feel otherwise having it in the project is good practice, we can change the wordings if we would like

I'm not sure what's the point in keeping it in the external docs if we're not going to allow external contributors

@jimidle
Copy link
Contributor

jimidle commented Mar 17, 2025

Not sure of the status - my review was requested, but it seems that changes are required?

Copy link
Collaborator

@gueniai gueniai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, we won't make the contributing portion visible outside, since it's not relevant to outside folks, but otherwise LGTM!

Copy link
Contributor

@jimidle jimidle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jimidle jimidle added this pull request to the merge queue Mar 27, 2025
Merged via the queue into main with commit e35261c Mar 27, 2025
6 checks passed
@jimidle jimidle deleted the feature/remorph_docs branch March 27, 2025 15:45
ericvergnaud added a commit that referenced this pull request Apr 3, 2025
* main:
  Improve lsp resiliency (#1491)
  Hot Fix for Dashboard Names (#1476)
  Improve installer resiliency (#1484)
  Patch Contributing Document (#1506)
  Introduce Documentation for Remorph (#1460)
  Fix missing dependencies (#1485)
  Installation Improvements (#1495)
  Update transpilers.md (#1486)
  Drop proxy commands (#1493)
  Fix labs.yml (#1490)
  Configure lsp custom options (#1487)
  Add support for DBT (#1456)
  Introduce table definition (#1450)
  Add Error handling Pipeline Execution (#1466)
  Enhance Profiler config to execute Python Script (#1465)
  Pipeline Executor for Profiling (#1453)
  Updated document On Python requirement (#1473)

# Conflicts:
#	src/databricks/labs/remorph/transpiler/lsp/lsp_engine.py
ericvergnaud added a commit that referenced this pull request Apr 4, 2025
* main:
  Improve lsp resiliency (#1491)
  Hot Fix for Dashboard Names (#1476)
  Improve installer resiliency (#1484)
  Patch Contributing Document (#1506)
  Introduce Documentation for Remorph (#1460)
  Fix missing dependencies (#1485)
  Installation Improvements (#1495)
  Update transpilers.md (#1486)
  Drop proxy commands (#1493)
  Fix labs.yml (#1490)
  Configure lsp custom options (#1487)
  Add support for DBT (#1456)

# Conflicts:
#	pyproject.toml
#	src/databricks/labs/remorph/config.py
#	src/databricks/labs/remorph/install.py
#	src/databricks/labs/remorph/transpiler/execute.py
#	tests/unit/test_install.py
github-merge-queue bot pushed a commit that referenced this pull request Apr 30, 2025
It looks like the documentation fix from #1486 was lost when #1460 was
merged. This PR:

 - Reapplies the fix to the JSON example.
 - Specifies the language for the JSON example, to improve rendering.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants