[
https://issues.apache.org/jira/browse/BEAM-12777?focusedWorklogId=702076&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-702076
]
ASF GitHub Bot logged work on BEAM-12777:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 29/Dec/21 21:04
Start Date: 29/Dec/21 21:04
Worklog Time Spent: 10m
Work Description: emilymye commented on a change in pull request #16327:
URL: https://github.com/apache/beam/pull/16327#discussion_r776492654
##########
File path: sdks/python/scripts/generate_pydoc.sh
##########
@@ -117,6 +118,8 @@ master_doc = 'index'
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
project = 'Apache Beam'
+version = version.__version__
Review comment:
I don't think it actually causes an issue right now since nothing is
getting used later, it just makes me nervous when we have variables with the
same names as packages. Could we alias the package as beam_version or something
similar?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 702076)
Time Spent: 6h (was: 5h 50m)
> Stable URL for "current" API Documentation
> ------------------------------------------
>
> Key: BEAM-12777
> URL: https://issues.apache.org/jira/browse/BEAM-12777
> Project: Beam
> Issue Type: Improvement
> Components: website
> Reporter: Ahmet Altay
> Assignee: Mike Hernandez
> Priority: P2
> Time Spent: 6h
> Remaining Estimate: 0h
>
> Discussion:
> https://lists.apache.org/thread.html/rc23610839204f2bba1ea148885ef9f496a3087a47d7bb25662a46bc5%40%3Cdev.beam.apache.org%3E
> Summary of the proposal:
> """
> You may have noticed that our API Documentation could really use some SEO.
> It's possible to search for Beam APIs (e.g. "beam dataframe read_csv" [1] or
> "beam java ParquetIO" [2]) and you will be directed to some documentation,
> but it almost always takes you to an old version. I think this could be
> significantly improved if we just make one change: rather than making
> https://beam.apache.org/releases/javadoc/current redirect to the latest
> release, we should just always stage the latest documentation there.
> To be clear I'm not 100% sure this will help. I haven't talked to any search
> engineers or SEO experts about it. I'm just looking at other projects as a
> point of reference. I've found that I never have trouble finding the latest
> pandas documentation (e.g. "pandas read_csv" [3]) since it always directs to
> "pandas-docs/stable/" rather than a particular version number.
> We should also make sure the version number shows up in the page title, it
> looks like this isn't the case for Python right now.
> """
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
