Move `developer-hub` to `sdk-docs` #2565

juangirini · 2023-11-30T10:22:04Z

This PR is a continuation of #2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp
What has been done:

The content under docs/* (with the exception of docs/mermaid) has been moved to docs/contributor/
Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from developer-hub to sdk-docs
The content under developer-hub/* has been moved to docs/sdk

…k into kiz-developer-hub

…developer-hub

…k into kiz-developer-hub

Co-authored-by: Juan Girini <[email protected]>

Co-authored-by: bader y <[email protected]>

Co-authored-by: Sebastian Kunert <[email protected]>

Co-authored-by: Juan Girini <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Liam Aharon <[email protected]>

Co-authored-by: Liam Aharon <[email protected]> Co-authored-by: Juan Girini <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]>

paritytech-cicd-pr · 2023-11-30T10:46:24Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: cargo-clippy
Logs: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/4554928

rmnprkrl

Found some "developer_hub" references, not sure if you planned to do it in a separate PR?
I think it might be good to test the build-rustdoc pipeline to check everything works.

rmnprkrl · 2023-12-01T08:54:21Z

.gitlab/pipeline/build.yml

@@ -125,7 +125,7 @@ build-rustdoc:
        find "$path" -name '*.html' | xargs -I {} -P "$(nproc)" bash -c 'process_file "$@"' _ {}
      }
      inject_simple_analytics "./crate-docs"
-    - echo "<meta http-equiv=refresh content=0;url=polkadot_service/index.html>" > ./crate-docs/index.html
+    - echo "<meta http-equiv=refresh content=0;url=developer_hub/index.html>" > ./crate-docs/index.html


pipeline references "developer_hub"

that def needs to be updated, @juangirini worth doing a global search / grep of the workspace for developer_hub before merging this if you haven't already

sorry guys, there's been some rebase conflicts that broke the PR after changing its base to master, I'll try to fix this PR, otherwise I'll close it and open a new one

rmnprkrl · 2023-12-01T08:57:51Z

docs/mermaid/IA.mmd

@@ -0,0 +1,14 @@
+flowchart
+    parity[paritytech.github.io] --> devhub[developer_hub]


should reference the folder or the crate:

"docs/sdk"

"sdk-docs"

rmnprkrl · 2023-12-01T08:58:57Z

docs/sdk/headers/toc.html

@@ -0,0 +1,54 @@
+<script>


rust docs template references "developer_hub"

rmnprkrl · 2023-12-01T09:00:23Z

docs/sdk/src/polkadot_sdk/mod.rs

+//! * [`substrate`], for an overview of what Substrate as the main blockchain framework of Polkadot
+//!   SDK.
+//! * [`frame`], to learn about how to write blockchain applications aka. "App Chains".
+//! * Continue with the [`developer_hub`'s "getting started"](crate#getting-started).


developer_hub

rmnprkrl · 2023-12-01T09:00:33Z

substrate/frame/src/lib.rs

@@ -34,14 +30,21 @@
 //! > **F**ramework for **R**untime **A**ggregation of **M**odularized **E**ntities: Substrate's
 //! > State Transition Function (Runtime) Framework.
 //!
+//! ## Documentation
+//!
+//! See [`polkadot_sdk::frame`](../developer_hub/polkadot_sdk/frame_runtime/index.html).


developer_hub

rmnprkrl · 2023-12-01T09:25:20Z

regarding the crate name, do you think it is worth to consider "sdk-docs" vs "polkadot-sdk-docs"?

juangirini · 2023-12-04T11:24:16Z

closed in favour of #2598

This PR is a continuation of #2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR #2565, it has been close due to too many rebase conflicts --------- Co-authored-by: Serban Iorga <[email protected]> Co-authored-by: Chevdor <[email protected]> Co-authored-by: Egor_P <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>

This PR is a continuation of paritytech#2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR paritytech#2565, it has been close due to too many rebase conflicts --------- Co-authored-by: Serban Iorga <[email protected]> Co-authored-by: Chevdor <[email protected]> Co-authored-by: Egor_P <[email protected]> Co-authored-by: Bastian Köcher <[email protected]>

kianenigma and others added 30 commits October 31, 2023 09:55

add developer-hub and all things related

a451f7e

fix some things

68a053b

small fixes

f7460d8

Create docs.yml

b785e5c

Update docs.yml

00a0fec

fix some warnings

50c78b4

Merge branch 'kiz-developer-hub' of github.com:kianenigma/polkadot-sd…

89e00e9

…k into kiz-developer-hub

fix some warnings

c91250b

fix warns

6d57d2e

update

76f2277

fix

08802f8

publish note

2ec4541

fix

a826834

Master.into()

8e2f6b8

Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…

df2d645

…developer-hub

fix build

58d60cb

default page developer hub

c8f7f1e

Master.into()

198a3e6

add lot of ref docs

bcdc9d5

Merge branch 'kiz-developer-hub' of github.com:paritytech/polkadot-sd…

4664874

…k into kiz-developer-hub

Update substrate/frame/support/procedural/src/pallet/parse/call.rs

d542ff1

Co-authored-by: Juan Girini <[email protected]>

Update developer-hub/src/lib.rs

2f76ba1

Co-authored-by: bader y <[email protected]>

Update developer-hub/src/lib.rs

00ec677

Co-authored-by: bader y <[email protected]>

Update docs/mermaid/polkadot_sdk.mmd

9b1db8c

Co-authored-by: Sebastian Kunert <[email protected]>

Update developer-hub/src/polkadot_sdk/mod.rs

7dba4f8

Co-authored-by: Sebastian Kunert <[email protected]>

Update developer-hub/src/reference_docs/wasm_meta_protocol.rs

3519a03

Co-authored-by: Sebastian Kunert <[email protected]>

Apply suggestions from code review

0d72dd7

Co-authored-by: Juan Girini <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Liam Aharon <[email protected]>

Apply suggestions from code review

9942120

Co-authored-by: Liam Aharon <[email protected]> Co-authored-by: Juan Girini <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]>

Upstream.into()

60a37a1

reword templates page.

1896ac7

juangirini added 6 commits November 28, 2023 16:52

apply review suggestions

cefc9d4

some minor improvements

f65ece4

Merge branch 'master' into kiz-developer-hub

1166806

Merge branch 'master' into kiz-developer-hub

9e08068

move developer-hub to sdk-docs

83b27ff

fix contributing link

88ba11c

juangirini mentioned this pull request Nov 30, 2023

Introduce Polkadot-Sdk developer_hub #2102

Merged

5 tasks

liamaharon approved these changes Nov 30, 2023

View reviewed changes

juangirini self-assigned this Nov 30, 2023

juangirini added the T11-documentation This PR/Issue is related to documentation. label Nov 30, 2023

juangirini marked this pull request as ready for review November 30, 2023 10:38

juangirini requested a review from a team as a code owner November 30, 2023 10:38

paritytech-review-bot bot requested a review from a team November 30, 2023 10:39

juangirini added 2 commits November 30, 2023 11:49

add ignored file

628ec5e

fix markdownlint

d06870d

Base automatically changed from kiz-developer-hub to master November 30, 2023 11:15

juangirini requested review from a team November 30, 2023 11:15

juangirini requested a review from andresilva as a code owner November 30, 2023 11:15

juangirini requested a review from a team November 30, 2023 11:15

juangirini requested a review from koute as a code owner November 30, 2023 11:15

rmnprkrl reviewed Dec 1, 2023

View reviewed changes

juangirini mentioned this pull request Dec 4, 2023

Move developer-hub to polkadot-sdk-docs #2598

Merged

juangirini closed this Dec 4, 2023

juangirini deleted the jg/sdk-docs branch December 4, 2023 16:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move `developer-hub` to `sdk-docs` #2565

Move `developer-hub` to `sdk-docs` #2565

juangirini commented Nov 30, 2023 •

edited

Loading

paritytech-cicd-pr commented Nov 30, 2023

rmnprkrl left a comment •

edited

Loading

rmnprkrl Dec 1, 2023

liamaharon Dec 1, 2023

juangirini Dec 1, 2023

rmnprkrl Dec 1, 2023

rmnprkrl Dec 1, 2023

rmnprkrl Dec 1, 2023

rmnprkrl Dec 1, 2023

rmnprkrl commented Dec 1, 2023

juangirini commented Dec 4, 2023

		@@ -0,0 +1,14 @@
		flowchart
		parity[paritytech.github.io] --> devhub[developer_hub]

Move developer-hub to sdk-docs #2565

Move developer-hub to sdk-docs #2565

Conversation

juangirini commented Nov 30, 2023 • edited Loading

paritytech-cicd-pr commented Nov 30, 2023

rmnprkrl left a comment • edited Loading

Choose a reason for hiding this comment

rmnprkrl Dec 1, 2023

Choose a reason for hiding this comment

liamaharon Dec 1, 2023

Choose a reason for hiding this comment

juangirini Dec 1, 2023

Choose a reason for hiding this comment

rmnprkrl Dec 1, 2023

Choose a reason for hiding this comment

rmnprkrl Dec 1, 2023

Choose a reason for hiding this comment

rmnprkrl Dec 1, 2023

Choose a reason for hiding this comment

rmnprkrl Dec 1, 2023

Choose a reason for hiding this comment

rmnprkrl commented Dec 1, 2023

juangirini commented Dec 4, 2023

Move `developer-hub` to `sdk-docs` #2565

Move `developer-hub` to `sdk-docs` #2565

juangirini commented Nov 30, 2023 •

edited

Loading

rmnprkrl left a comment •

edited

Loading