Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CF-99: Separate docs per version #504

Merged
merged 8 commits into from
Mar 9, 2022
Merged

Conversation

aboedo
Copy link
Member

@aboedo aboedo commented Mar 8, 2022

updates the output directory for dokka to include the version number.

This is the low-tech implementation.

A high-tech implementation would be to use the Versioning plugin, but that might take a lot more effort to set up, so in the meantime, the idea is to manually update the docs in S3 for the first time, and use this to generate them in the correct subfolder until we get the high-tech implementation in place.

Fixes CF-99

@aboedo aboedo requested a review from a team March 8, 2022 21:39
@aboedo aboedo self-assigned this Mar 8, 2022
@aboedo aboedo requested a review from vegaro March 9, 2022 17:20
@aboedo aboedo force-pushed the feature/separate_docs_per_version branch from 967a11c to a448e41 Compare March 9, 2022 17:21
@aboedo
Copy link
Member Author

aboedo commented Mar 9, 2022

@vegaro I made a few updates here so that we can include an index.html file that automatically redirects you to the latest version of the docs, if you didn't specify a version, could you take a look at that bit too?

@aboedo aboedo requested a review from a team March 9, 2022 17:21
</head>
<body>
</body>
</html>
Copy link
Contributor

Choose a reason for hiding this comment

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

I had forgotten about this file 😄

Copy link
Member Author

Choose a reason for hiding this comment

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

this is a new file tho 😂 I just created it today so it would redirect automatically

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh. I had uploaded one to AWS so it would redirect to the https://sdk.revenuecat.com/android/docs/index.html if accessing https://sdk.revenuecat.com/android/index.html. But I think that's long time gone 😄

command: aws s3 sync ~/purchases-android/docs/5.1.0-SNAPSHOT s3://purchases-docs/android/5.1.0-SNAPSHOT --delete
- run:
name: Update index.html
command: aws s3 cp ~/purchases-android/docs/index.html s3://purchases-docs/android/index.html
Copy link
Contributor

Choose a reason for hiding this comment

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

We can move these two to fastlane one day. Not now

@@ -176,7 +178,7 @@ platform :android do
end

def increment_version_in(previous_version, new_version, path)
sed_regex = 's/' + previous_version + '/' + new_version + '/'
sed_regex = 's/' + previous_version + '/' + new_version + '/g'
Copy link
Member Author

Choose a reason for hiding this comment

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

we should always have been doing /g otherwise it only replaces the first instance in the file

@aboedo aboedo changed the title Separate docs per version Separate docs per version [CF-99] Mar 9, 2022
@aboedo aboedo changed the title Separate docs per version [CF-99] Separate docs per version Mar 9, 2022
@aboedo aboedo changed the title Separate docs per version CF-99: Separate docs per version Mar 9, 2022
@aboedo aboedo merged commit 417eacd into main Mar 9, 2022
@aboedo aboedo deleted the feature/separate_docs_per_version branch March 9, 2022 20:39
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.

2 participants